使用说明(Markdown格式)

  • 项目简介

    • 该仓库是一套面向 MCP(Model Context Protocol)的服务器模板集合,旨在向 LLM 客户端以标准化方式提供上下文信息、资源数据、工具调用能力以及 Prompt 模板渲染能力。核心通过 JSON-RPC 与客户端通信,支持 STDIO、HTTP 等传输模式,具备会话管理、能力声明以及多工具服务器的模块化设计。
  • 主要功能点

    • MCP 核心能力:实现初始化、工具列表、工具调用、能力声明、资源与提示的渲染与管理,支持 JSON-RPC 协议的请求/响应流转。
    • 模块化服务器:覆盖代码质量、内容创建、3D/影视/音视频、虚拟角色、GitHub Board 等场景,便于按需开启或替换各自的 MCP 服务。
    • 传输与部署模式:内置 STDIO 与 HTTP(包括 SSE/流式传输)的传输模式,方便本地开发与远程部署。
    • 容器化与自托管:强调容器优先、零外部依赖、可在 Docker/Docker Compose 下运行,便于自托管环境。
    • 客户端与测试:提供用于测试 MCP 服务器的脚本与工具(包括测试服务器、简单 CLI、以及工具执行示例),方便开发与验证。
  • 安装步骤

    • 克隆仓库并进入项目目录:
      • 克隆后进入仓库根目录,确保有 Docker 与 Docker Compose(若选择容器化部署)。
    • 构建与启动服务器(推荐容器化)
      • 使用容器化方式启动:按照仓库提供的容器化配置和示例脚本,通过 docker-compose 启动相关 MCP 服务器。
      • 也可在本地环境直接运行各 MCP 服务器(基于 Python 模块路径)以开发和测试。
    • 客户端配置(MCP 客户端如何连接服务器,此处只提供示例说明)
      • MCP 客户端连接需要一份配置,包含服务器名称、启动命令(command)和参数(args)。该配置用于客户端启动后建立与 MCP 服务器的连接,进行工具列表获取与工具调用等交互。
    • 验证测试
      • 使用提供的测试脚本与 Quickstart 指引,验证服务器健康、工具清单以及简单工具调用是否正常工作。
  • 服务器配置(给 MCP 客户端使用的 JSON 配置示例)

    • 说明:以下为示例配置,仅用于描述如何在客户端侧启动并连接到某一个 MCP 服务器。实际使用时,请按需要将 server_name、command、args 调整为目标 MCP 服务器的启动信息。
    • 示例 JSON(单个服务器配置): { "server_name": "Code Quality MCP Server", "command": ["python", "-m", "tools.mcp.mcp_code_quality.mcp_code_quality.server"], "args": ["--mode", "http"] }
    • 注解:
      • server_name:MCP 服务器的名称,客户端用于标识与记录。
      • command:启动服务器的命令(在容器或本地环境中均可执行的启动命令)。
      • args:启动参数,例如模式选择(http 表示以 HTTP 传输运行,供客户端通过 HTTP 调用)。
      • 如需连接其他 MCP 服务器,请对应替换 server_name、command 与 args。
  • 基本使用方法

    • 启动与连接
      • 通过容器化部署启动后,MCP 服务将对外暴露接口,客户端通过 JSON-RPC 调用工具列表、执行工具等。
      • 客户端要先启动并连接 MCP 服务器,提供 server_name、command、args 的配置信息,使得客户端能够通过统一的入口与 MCP 服务器交互。
    • 常用操作
      • 获取工具列表:查询 MCP 服务器提供的工具名称和输入参数结构。
      • 调用工具:发送工具名称和参数,获取执行结果。
      • 初始化与能力声明:服务在启动阶段进行初始化,声明支持的工具、资源、Prompts 等能力。
    • 运行环境要点
      • 若使用容器,建议遵循仓库中的容器化部署方案,确保网络、端口映射与依赖就绪。
      • 若本地运行,请确保 Python 环境可用并正确设置了所需的依赖。

信息

分类

AI与计算