README
¶
Examples
Example stacks demonstrating Gridctl patterns and capabilities.
🚀 Quick Start
gridctl apply examples/getting-started/mcp-basic.yaml
📁 Categories
| Folder | Description |
|---|---|
| 🎯 getting-started/ | Basic examples to get up and running |
| 🔌 transports/ | MCP transport types: local process, SSH, HTTP, SSE |
| 📦 platforms/ | Third-party MCP servers (container-based) |
| 🔗 openapi/ | Turn REST APIs into MCP tools via OpenAPI specs |
| 🔐 access-control/ | Tool filtering and security patterns |
| ⚡ code-mode/ | Reduce context window with search + execute meta-tools |
| 🔒 gateways/ | Bridge to existing infrastructure |
| 🔑 secrets-vault/ | Encrypted variables and variable sets |
| 📈 autoscale/ | Static replicas and reactive autoscaling |
| 🧳 portable-stack/ | Single-file portable stack with inlined config |
| 🔭 tracing/ | Distributed tracing and OTLP export |
| 📋 registry/ | Skills registry (agentskills.io spec) |
| 🧪 _mock-servers/ | Test servers for development |
🎬 Recommended Path
- Start here:
getting-started/mcp-basic.yaml- stack, networking, tool filtering (placeholder containers) - Real MCP servers:
transports/local-mcp.yaml- actual MCP server logic via stdio transport - Platforms:
platforms/github-mcp.yaml- third-party MCP servers - OpenAPI:
openapi/openapi-basic.yaml- turn any REST API into MCP tools - Registry:
registry/registry-basic.yaml- Skills as MCP prompts - Scaling:
autoscale/autoscale-basic.yaml- reactive autoscaling of MCP replicas
Note: Getting-started examples use placeholder containers to focus on infrastructure concepts. Transport and platform examples include real MCP server implementations.
📊 Feature Matrix
| Example | Transports | Tool Filtering | External | OpenAPI | Registry | Code Mode | Variables |
|---|---|---|---|---|---|---|---|
| mcp-basic | - | ✅ | - | - | - | - | - |
| local-mcp | stdio | - | - | - | - | - | - |
| ssh-mcp | ssh+stdio | - | - | - | - | - | - |
| external-mcp | http, sse | - | ✅ | - | - | - | - |
| atlassian-mcp | sse | - | ✅ | - | - | - | - |
| chrome-devtools-mcp | stdio | - | ✅ | - | - | - | - |
| context7-mcp | stdio | - | ✅ | - | - | - | - |
| github-mcp | stdio | - | ✅ | - | - | - | - |
| zapier-mcp | stdio | - | ✅ | - | - | - | - |
| openapi-basic | openapi | - | - | ✅ | - | - | - |
| openapi-auth | openapi | - | - | ✅ | - | - | - |
| tool-filtering | - | ✅ | - | - | - | - | - |
| code-mode-basic | - | - | - | - | - | ✅ | - |
| gateway-basic | http | - | ✅ | - | - | - | - |
| gateway-remote | http | - | ✅ | - | - | - | - |
| var-basic | stdio | - | - | - | - | - | ✅ |
| var-sets | - | - | - | - | - | - | ✅ |
| registry-basic | stdio | - | - | - | ✅ | - | - |
| registry-advanced | stdio | - | - | - | ✅ | - | - |
💻 Usage Pattern
All examples follow the same deployment pattern:
# Deploy a stack
gridctl apply examples/<category>/<file>.yaml
# Force recreate containers
gridctl apply examples/<category>/<file>.yaml
# View status
gridctl status
Directories
¶
| Path | Synopsis |
|---|---|
|
_mock-servers
|
|
|
local-stdio-server
command
Mock MCP Server for testing local process (stdio) MCP server support.
|
Mock MCP Server for testing local process (stdio) MCP server support. |
|
mock-mcp-server
command
Mock MCP Server for testing external HTTP/SSE MCP server support.
|
Mock MCP Server for testing external HTTP/SSE MCP server support. |
Click to show internal directories.
Click to hide internal directories.