Codeguide MCP

MCP服务器编码指南

一个模型上下文协议（MCP）服务器，为Claude和GitHub Copilot等AI助手提供编码指南和最佳实践的访问。

这是什么？

此MCP服务器将编码指南和样式指南作为MCP客户端可以访问的资源公开。它旨在扩展或替换 AGENTS.md 通过提供一种结构化的方式，在开发过程中为AI助手提供编码实践和指导方针。

特性

• 基于资源的API：通过MCP资源公开编码指南
• GitHub集成：通过网络从GitHub存储库加载指南
• 自动缓存：在本地缓存下载的指南，以便离线访问
• 后备支援：网络不可用时使用本地缓存或目录
• 简单的基于文件的存储：指南可以本地存储为Markdown文件
• FastMCP框架：基于高效的FastMCP库，可快速开发
• 轻松集成：适用于任何兼容MCP的客户端（Claude Desktop、Cline等）

可用资源

• guides://list -列出所有可用的编码指南
• guides://{guide_name} -检索特定指南的内容（例如。， guides://python.md)

安装

来源

# Clone the repository
git clone https://github.com/delian/codeguide-mcp.git
cd codeguide-mcp

# Install with uv (recommended)
uv install

# Or with pip
pip install -e .

使用Docker

docker build -t codeguide-mcp .
docker run -i codeguide-mcp

配置

通过创建 config.toml 文件或设置环境变量：

GitHub配置（推荐）

要从GitHub存储库加载指南，请执行以下操作：

github_repo = "owner/repository"  # e.g., "delian/codeguide-mcp"
github_path = "guides"            # Path to guides directory in repo
github_branch = "main"            # Branch to fetch from
  cache_dir = ".guides-cache"       # Local cache directory
log_level = "INFO"

本地目录配置

仅使用本地指南：

guides_dir = "guides"
log_level = "INFO"

环境变量

• GUIDES_GITHUB_REPO -GitHub存储库（格式： owner/repo)
• GUIDES_GITHUB_PATH -存储库中指南目录的路径（默认： guides)
• GUIDES_GITHUB_BRANCH -要从中提取的分支（默认值： main)
• GUIDES_CACHE_DIR -本地缓存目录（默认： .guides-cache)
• GUIDES_DIR -包含指南文件的本地目录（默认： guides)
• GUIDES_LOG_LEVEL -日志记录级别（默认值： INFO)

行为

1. 网络可用+已配置GitHub：从GitHub获取指南并在本地缓存
2. 网络不可用：使用本地缓存（如果可用）
3. 没有可用缓存：回落到本地 guides_dir 如果已配置

添加指南

使用GitHub（推荐）

如果您已配置 github_repo，只需将Markdown文件添加到GitHub存储库中的指定目录即可。服务器将自动获取并缓存它们。

使用本地目录

将Markdown文件添加到 guides/ 目录。每个文件都将自动作为资源可用。

例子：

echo "# Python Style Guide\n\nUse PEP 8..." > guides/python.md

与MCP客户端一起使用

克劳德桌面版

添加到您的 mcp.json:

{
  "mcpServers": {
    "coding-guides": {
      "command": "python",
      "args": ["-m", "main"]
    }
  }
}

或

{
  "mcpServers": {
    "coding-guides": {
      "command": "docker",
      "args": ["run", "--rm", "-i", "docker.io/delian/codeguide-mcp"]
    }
  }
}

其他MCP客户端

运行服务器并通过stdio连接：

python main.py

发展

# Install development dependencies
uv pip install -e ".[dev]"

# Run pre-commit hooks
pre-commit install
pre-commit run --all-files

# Run the server
python main.py

许可证

麻省理工学院

贡献

欢迎投稿！请打开问题或拉取请求。