Skip to main content

MCP Server for handling guidelines, project rules and a controlled development workflow

Project description

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.

Project 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.3.2.tar.gz (286.8 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.3.2-py3-none-any.whl (470.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mcp_guide-1.3.2.tar.gz
  • Upload date:
  • Size: 286.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for mcp_guide-1.3.2.tar.gz
Algorithm Hash digest
SHA256 625711d255a461caa5e15ce26380fb3cbc088076b8cf60527667ab4ad8881af4
MD5 491fe1f43dbd2583cc2945af505f734e
BLAKE2b-256 76b96bdd643010d5678fec7e15f6089247d2785e8a511fe54e3fbd48de956987

See more details on using hashes here.

Provenance

The following attestation bundles were made for mcp_guide-1.3.2.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.3.2-py3-none-any.whl.

File metadata

  • Download URL: mcp_guide-1.3.2-py3-none-any.whl
  • Upload date:
  • Size: 470.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for mcp_guide-1.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e48f0a37b04f4177aa1274fc6d463b1b8540240d6bf926fc6c312700f9b5fde4
MD5 f0b41ee8f745afbe2b9d0f1c082a2902
BLAKE2b-256 c3ab093449134a57dfb9faec2f19ef5dedf1aa9ca757ea5f33eb2b2f1c70db5d

See more details on using hashes here.

Provenance

The following attestation bundles were made for mcp_guide-1.3.2-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 Pingdom Monitoring Sentry Error logging StatusPage Status page