mcp-guide Documentation¶
Structured content delivery for AI agents via Model Context Protocol
mcp-guide is an MCP server that provides AI agents with organised access to project guidelines, documentation, and context.
Key Features¶
| Feature | Description |
|---|---|
| Content Management | Organise documents, instructions and prompts by categories and collections |
| Template Support | Dynamic content with Mustache/Chevron templates |
| Multiple Transports | STDIO, HTTP, and HTTPS modes |
| Feature Flags | Project-specific and global configuration |
| Workflow Management | Structured development phase tracking |
| Profile System | Pre-configured setups for common scenarios |
| Docker Support | Containerised deployment with SSL |
| OpenSpec Integration | Spec-driven development workflow |
Basics¶
- Getting Started - Quick introduction and first steps
- Installation - Installation and setup instructions
- Prompt Commands - Prompt command reference
User Guide¶
Core Concepts¶
- Categories and Collections - Organising your project documentation
- Documents - Understanding document types and references
Features¶
- Guide URIs - Accessing content via the
guide://URI scheme - Stored Documents - Ingesting and managing external content
- Workflows - Structured development phase tracking
- OpenSpec Integration - Spec-driven development workflow
Configuration¶
- Content Management - Working with content in your project
- Feature Flags - Configuring project and global features
- Profiles - Using pre-configured project templates
Developer Notes¶
- Developer Setup - Setting up mcp-guide for development
- Command Authoring - Creating custom commands
- Template Rendering - Working with templates and frontmatter
- Filesystem Access - Security and access patterns
- Debugging - Debugging and troubleshooting