使用说明(Markdown 格式)

  • 项目简介

    • 该项目围绕 Model Context Protocol(MCP)构建一个后端服务器框架,核心职责是向 LLM 客户端提供标准化的上下文信息与功能支持。核心能力包括:资源(Resources)的托管与访问、工具(Tools)的注册与执行、Prompt 模板的定义与渲染,以及对多种传输协议(如 STDIO、SSE、WebSocket)的支持,提供安全、可扩展的上下文服务框架。
    • 服务器通过 JSON-RPC 与客户端通信,接收并响应读取资源、调用工具、获取 Prompts 等请求,并具备会话管理、能力声明等能力,便于在不同执行环境中部署与扩展。
  • 主要功能点

    • 资源管理:托管与访问数据资源,提供统一的资源访问接口。
    • 工具注册与执行:注册外部功能/CLI 命令/REST API 等作为 Tools,并支持通过 MCP 客户端调用工具及其参数化执行。
    • Prompt 模板渲染:定义与渲染用于与 LLM 交互的提示模板,支持定制化交互模式。
    • JSON-RPC 通信:遵循 MCP 规范,通过标准的 JSON-RPC 请求/响应进行交互。
    • 多传输协议支持:提供 STDIO、SSE、WebSocket 等传输方式的适配器,确保在不同运行环境中通讯。
    • 会话管理与能力声明:维护客户端会话、声明服务器能力以提升可预测性与可扩展性。
    • 安全与扩展性:设计上允许多后端存储、命名空间分离以及插件式工具/资源扩展。
  • 安装与运行步骤

    • 环境要求
      • Python 3.11 及以上
    • 安装
      • 将仓库内容安装到环境中(若提供打包版本,请使用相应包管理器安装,例如 pip install . 或 pip install -e .,以便本地开发与测试)
    • 启动 MCP 服务器
      • 常用命令(作为服务器示例,请以实际环境为准):
        • py-code-mode-mcp --storage /path/to/mcp/storage
        • 或通过 RFC/CLI 文档指定的入口启动命令,并传入存储路径参数
      • 启动后,服务器将对外暴露 JSON-RPC 接口,客户端可通过 MCP 客户端连接并交互
    • 服务器配置示例(用于 MCP 客户端连接,非代码形式的文本描述) { "server_name": "py-code-mode-mcp", "command": "py-code-mode-mcp", "args": ["--storage", "/path/to/mcp/storage"] } 说明:
      • server_name: MCP 服务器在客户端注册时的名称,便于标识与调试
      • command: 启动 MCP 服务器的可执行入口
      • args: 启动参数,示例中包含存储目录路径,客户端无需额外配置
    • 基本使用方法
      • 客户端连接流程(简述)
        1. 启动 MCP 服务器并确保存储目录可用
        2. 使用 MCP 客户端连接到服务器,初始化会话
        3. 调用 list_tools、list_skills、list_artifacts 等工具接口获取能力与资源信息
        4. 使用 call_tool 调用工具,或运行 skills.invoke、artifacts.save/load 等命令
        5. 如需运行自定义代码/技能,使用 run_code 相关接口进行运行与持久化
      • 典型用例包括:获取工具列表、执行工具、创建并调用技能、保存/读取工件等
  • 可信性与注意事项

    • MCP 服务器应实现对各种资源、工具、提示模板的有效注册、访问与渲染,确保与 MCP 客户端的 JSON-RPC 交互符合规范。
    • 服务器端需要提供会话管理、能力声明,以及对多传输协议的支持,以提升在不同运行环境中的兼容性与安全性。
    • 如需集成到 Claude Code 等外部系统,请按照项目文档中的 Getting Started 指引进行部署,并使用提供的 MCP 服务器入口命令启动服务。
  • 额外信息与参考

    • 与 MCP 相关的适配器与工具注册实现分散在仓库的不同模块中,核心目标是让 MCP 客户端可以通过标准接口读取工具、执行工具、管理技能和工件等,并实现跨命名空间的调用与数据传递。

信息

分类

AI与计算