使用说明

项目简介

Coding Standards MCP Server 是一个基于 Model Context Protocol (MCP) 的后端服务，旨在为大型语言模型 (LLM) 客户端提供访问各种编程语言和技术栈的代码规范和最佳实践指南的能力。它通过标准化的 MCP 协议与客户端通信，允许 LLM 应用便捷地获取和利用这些宝贵的开发知识。

主要功能点

代码规范查询: 提供 Java, Python 和 React 等常用技术栈的代码风格指南，帮助开发者遵循统一的编码规范。
最佳实践查询: 提供 Java, Python 和 React 等常用技术栈的最佳实践建议，涵盖项目结构、架构、测试、性能优化等方面。
Tool 接口: 通过 MCP Tool 接口暴露代码规范和最佳实践查询功能，方便 LLM 客户端调用。
Markdown 格式输出: 返回 Markdown 格式的内容，易于 LLM 理解和处理。

安装步骤

安装 Python 环境: 确保已安装 Python 3.8 或更高版本。
安装 MCP 包: 使用 pip 安装 MCP 包：
```
pip install mcp
```
推荐安装 'uv' 包管理器 (参考仓库 README)。

服务器配置

为了让 MCP 客户端能够连接到 Coding Standards MCP Server，需要在客户端的 MCP 配置 (通常是 'mcp_config.json' 文件) 中添加服务器配置信息。以下是一个配置示例，你需要根据实际情况修改：

{
  "mcpServers": {
    "coding_standards": {  // 服务器名称，客户端使用此名称引用
      "command": "uv",     // 启动服务器的命令，这里使用 uv
      "args": [          // 启动命令的参数
        "run",          // uv 的 run 命令
        "--with",       // uv 的参数，指定要加载的插件
        "mcp[cli]",     // 加载 mcp 命令行工具插件
        "mcp",          // 实际执行的命令，即 mcp
        "run",          // mcp 的 run 命令，用于运行服务器
        "/absolute/path/to/coding-standards-mcp/server.py" //  **[请替换为实际 server.py 文件的绝对路径]**  服务器脚本的路径
      ]
    }
  }
}

配置参数说明:

'"coding_standards"': 服务器名称，在 MCP 客户端配置中自定义，用于唯一标识此服务器。客户端在调用 Tool 时会使用此名称。
'"command": "uv"': 启动命令。这里配置为 'uv'，表示使用 'uv' 包管理器来运行服务器。如果直接使用 'python' 运行，可以修改为 '"command": "python"'。
'"args": [...]'：命令参数列表。
- '"/absolute/path/to/coding-standards-mcp/server.py"': 服务器脚本路径。务必替换为 'server.py' 文件在您本地文件系统中的绝对路径。 你需要将仓库下载到本地，并找到 'server.py' 文件的完整路径。

基本使用方法

配置完成后，MCP 客户端可以通过服务器名称 '"coding_standards"' 调用以下 Tool 来获取代码规范和最佳实践：

'coding_standards_list_templates()': 列出所有可用的模板，返回 JSON 格式的结果，包含 "style_guides" 和 "best_practices" 两类，每类下列出支持的语言和文件名。
'coding_standards_get_style_guide(language="java")': 获取指定语言的代码风格指南，例如 'language="java"', 'language="python"', 返回 Markdown 格式的风格指南。
'coding_standards_get_best_practices(language="java")': 获取指定语言的最佳实践，例如 'language="java"', 'language="python"', 'language="react"', 返回 Markdown 格式的最佳实践。

注意: Tool 名称中的 'nortal_coding_standards_' 前缀在实际 MCP 配置和调用时应替换为你在 'mcp_config.json' 中配置的服务器名称 '"coding_standards_"'。

关键词