examples/

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/gridctl/gridctl

Links

Open Source Insights

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/	Vault secrets and variable sets
📋 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
Workflows: registry/items/workflow-basic/ - executable skill workflows

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	Workflows	Code Mode	Vault
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	-	✅	-	-	-	-	-
vault-basic	stdio	-	-	-	-	-	-	✅
vault-sets	-	-	-	-	-	-	-	✅
registry-basic	stdio	-	-	-	✅	-	-	-
registry-advanced	stdio	-	-	-	✅	-	-	-
workflow-basic	stdio	-	-	-	✅	✅	-	-
workflow-parallel	stdio	-	-	-	✅	✅	-	-
workflow-conditional	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.
registry
items/incident-triage-hybrid command Incident-triage-hybrid is the hybrid-pattern reference: a Go skill whose handler reads its own SKILL.md body — the severity matrix, decision rules, runbook, and stakeholder template — and feeds it as the LLM system prompt.	Incident-triage-hybrid is the hybrid-pattern reference: a Go skill whose handler reads its own SKILL.md body — the severity matrix, decision rules, runbook, and stakeholder template — and feeds it as the LLM system prompt.
items/triage-go command Triage-go is the typed Go counterpart to examples/registry/items/triage-ts.	Triage-go is the typed Go counterpart to examples/registry/items/triage-ts.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL