Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

mcp-guide

Build Status Security Maintenance PyPI version PyPI downloads Python versions

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. It helps agents understand your project's standards, follow development workflows, and access relevant information through a flexible content management system.

Key Features

  • Content Management - Organise documents, instructions and prompts by category and collection
  • 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

Quick Start

mcp-guide is run using your AI Agent's MCP configuration, and not usually run directly, at least in stdio transport mode. In stdio mode, standard input and output are used to communicate with the MCP so the agent needs to control both in order to operate. In http mode, however, the server provides web server (http) transport, and this may be started in standalone mode, not necessarily by the agent directly (although typically it does).

The configurations below detail configuration with some cli agents, but almost all of them will be similar.

Configure with AI Agents

JSON configuration

These blocks can be used as is and inserted into the agent's configuration. The stdio mode is a straightforward configuration, although it requires the uv tool to be installed.

Stdio
{
  "mcpServers": {
    "mcp-guide": {
      "command": "uvx",
      "args": ["mcp-guide"]
    }
  }
}

If the "mcpServers" block already exists, add the "mcp-guide" block at the end, ensuring that the previously last item, if any, has a terminating comma.

Kiro-CLI

Add the above JSON block to ~/.kiro/settings/mcp.json.

Claude Code

Add the above JSON block to ~/.claude/settings.json.

GitHub Copilot CLI

Add this JSON block to ~/.config/.copilot/mcp.json.

Other clients will offer similar configuration, some also

See the Installation Guide for more detail in use with various clients, use with docker and using the http/sse transport mode.

Content Organisation

mcp-guide organises content using frontmatter (optional YAML metadata at the start of documents) to define document properties and behaviour.

Content is classified into three types via the type: field in frontmatter:

  • user/information - Content displayed to users
  • agent/information - Context for AI agents
  • agent/instruction - Directives for agent behaviour

Content is organised using categories (file patterns and directories) and collections (groups of categories). Collections act as "macros" to provide targeted context for specific tasks or purposes.

See Content Management for details.

Feature Flags

Feature flags control behaviour, capabilities and special features and may be set globally or per project:

  • workflow - Enable workflow phase tracking
  • openspec - Enable OpenSpec integration
  • content-style - Output format (None, plain, mime)

See Feature Flags for more information.

Documentation

License

MIT License - See LICENSE.md for details.

Metadata

Release files for mcp-guide 2.0.0b2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mcp-guide 2.0.0b2
File Size Uploaded
mcp_guide-2.0.0b2.tar.gz 365.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for mcp-guide 2.0.0b2
File Interpreter ABI Platform
mcp_guide-2.0.0b2-py3-none-any.whl Python 3 none any Details

Total release size: 969.2 kB

Release files / mcp_guide-2.0.0b2.tar.gz

Download URL mcp_guide-2.0.0b2.tar.gz
Size 365.1 kB
Tags Source
SHA-256 checksum
How to use checksums
f45d8de0f7963697b62797d345940be699e507bcb6d23241e52ee76e6378c8ed
BLAKE2b-256 checksum
How to use checksums
d84ca2aca761feabb3db6d1c6591dbb10777645d27cad07200e579d913415397
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 24, 2026.

Transparency log

Release files / mcp_guide-2.0.0b2-py3-none-any.whl

Download URL mcp_guide-2.0.0b2-py3-none-any.whl
Size 604.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
841cf2a3223bb5862ebb47a9b8af9e72dc98e51681ccc2cac5579a3d54af6791
BLAKE2b-256 checksum
How to use checksums
36385e46bf2db7629d8fbf9c8ad3beb2f27bf1248f62efab3f3066cddb972c71
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 24, 2026.

Transparency log
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page