Skip to main content

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

Links

License

MIT License - See LICENSE.md for details.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mcp_guide-1.4.0.tar.gz (380.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mcp_guide-1.4.0-py3-none-any.whl (564.1 kB view details)

Uploaded Python 3

File details

Details for the file mcp_guide-1.4.0.tar.gz.

File metadata

  • Download URL: mcp_guide-1.4.0.tar.gz
  • Upload date:
  • Size: 380.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for mcp_guide-1.4.0.tar.gz
Algorithm Hash digest
SHA256 983ea4b7c55b231c46a6ebf2dc70fa11cff8916808fb8b47b97bc2114d420bc1
MD5 4dbaf788274798a229e28b4defe6bdb1
BLAKE2b-256 3b6d5204764b9b09f2003aad429f859a9471df0923dd38758e2bb356dcdb4878

See more details on using hashes here.

Provenance

The following attestation bundles were made for mcp_guide-1.4.0.tar.gz:

Publisher: python-mcp-publish.yml on deeprave/mcp-guide

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mcp_guide-1.4.0-py3-none-any.whl.

File metadata

  • Download URL: mcp_guide-1.4.0-py3-none-any.whl
  • Upload date:
  • Size: 564.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for mcp_guide-1.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b48990cf5499786e9eac14a3355714b3382652e0ed2d14010297fe2b18e5c74d
MD5 a68c760828ac698ebe9c4149879c1232
BLAKE2b-256 3f0ef519f80c619a9008c2cd3b6f4296bd2acf87e7fe5b8eccc0c276e922a01d

See more details on using hashes here.

Provenance

The following attestation bundles were made for mcp_guide-1.4.0-py3-none-any.whl:

Publisher: python-mcp-publish.yml on deeprave/mcp-guide

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page