Metadata-Version: 2.3
Name: mcp-guide
Version: 1.2.0rc2
Summary: MCP Server for handling guidelines, project rules and a controlled development workflow
Author: David Nugent
Author-email: David Nugent <davidn@uniquode.io>
License: # MIT License
         
         Copyright (c) 2025 David L Nugent
         
         Permission is hereby granted, free of charge, to any person obtaining a copy
         of this software and associated documentation files (the "Software"), to deal
         in the Software without restriction, including without limitation the rights
         to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
         copies of the Software, and to permit persons to whom the Software is
         furnished to do so, subject to the following conditions:
         
         The above copyright notice and this permission notice shall be included in all
         copies or substantial portions of the Software.
         
         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
         IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
         FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
         AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Communications
Requires-Dist: fastmcp>=3.1.1
Requires-Dist: pydantic>=2.0
Requires-Dist: anyio>=4.5
Requires-Dist: pyyaml>=6.0
Requires-Dist: chevron>=0.14.0
Requires-Dist: click>=8.3.0
Requires-Dist: uuid7>=0.1.0
Requires-Dist: patch-ng>=1.19.0
Requires-Dist: packaging>=24.0
Requires-Dist: pygments>=2.19.2
Requires-Dist: mkdocs>=1.5.0 ; extra == 'docs'
Requires-Dist: mkdocs-material>=9.5.0 ; extra == 'docs'
Requires-Dist: mike>=2.0.0 ; extra == 'docs'
Requires-Dist: yq>=3.0.0 ; extra == 'docs'
Requires-Dist: uvicorn>=0.27.0 ; extra == 'http'
Requires-Python: >=3.12
Project-URL: Homepage, https://github.com/deeprave/mcp-guide
Project-URL: Documentation, https://deeprave.github.io/mcp-guide/
Project-URL: Repository, https://github.com/deeprave/mcp-guide
Project-URL: Issues, https://github.com/deeprave/mcp-guide/issues
Provides-Extra: docs
Provides-Extra: http
Description-Content-Type: text/markdown

# mcp-guide

[![Build Status](https://img.shields.io/github/actions/workflow/status/deeprave/mcp-guide/python-mcp-docs.yml?branch=main&label=docs&logo=github)](https://github.com/deeprave/mcp-guide/actions/workflows/python-mcp-docs.yml)
[![Security](https://img.shields.io/github/actions/workflow/status/deeprave/mcp-guide/codeql.yml?branch=main&label=security&logo=github)](https://github.com/deeprave/mcp-guide/security/code-scanning)
[![Maintenance](https://img.shields.io/badge/maintenance-active-brightgreen.svg)](https://github.com/deeprave/mcp-guide)
[![PyPI version](https://img.shields.io/pypi/v/mcp-guide.svg?logo=pypi&logoColor=white)](https://pypi.org/project/mcp-guide/)
[![PyPI downloads](https://img.shields.io/pypi/dm/mcp-guide.svg?logo=pypi&logoColor=white)](https://pypi.org/project/mcp-guide/)
[![Python versions](https://img.shields.io/pypi/pyversions/mcp-guide.svg?logo=python&logoColor=white)](https://pypi.org/project/mcp-guide/)

**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
```json
{
  "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](docs/user/installation.md) 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](docs/user/content-management.md) 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](docs/user/feature-flags.md) for more information.

## Documentation

- **[Documentation Index](docs/index.md)** - Documentation overview
- **[Getting Started](docs/user/getting-started.md)** - First-time setup and basic concepts
- **[Changelog](CHANGELOG.md)** - Release notes and version history

## Links

- **Documentation**: [docs/user/](docs/index.md)
- **Issues**: [GitHub Issues](https://github.com/deeprave/mcp-guide/issues)
- **MCP Protocol**: [modelcontextprotocol.io](https://modelcontextprotocol.io/)

## License

MIT License - See [LICENSE.md](LICENSE.md) for details.
