使用说明内容(Markdown格式)
-
项目简介
- 该仓库实现一个 MCP 服务器端框架,按 MCP 协议向 LLM 客户端暴露资源、工具和提示模板等能力。服务器端负责会话管理、能力声明,以及对资源、工具和提示模板的托管、查询和执行,支持通过多种传输协议(如 STDIO、SSE、WebSocket)与客户端通信,并实现 JSON-RPC 风格的请求/响应。
-
主要功能点
- 资源管理:托管并管理资源(Resources),提供数据访问能力,以便 LLM 客户端在对话中查询和使用相关数据。
- 工具注册与执行:注册可供 LLM 调用的外部功能工具(Tools),并在 MCP 会话中执行工具。
- 提示模板(Prompts):定义与渲染可定制的 Prompt 模板,支持多种交互模式。
- JSON-RPC 通信:服务器按 MCP 约定接收 JSON-RPC 请求并返回标准化的响应或通知。
- 会话与能力声明:维护会话状态、能力清单,并能根据需要扩展或调整能力。
- 多 MCP 服务:通过内置 MCP 配置加载,支持从不同作用域加载 MCP 服务器配置(如用户、项目、全局等),并将其转换为 MCP 客户端可用的服务器描述。
- 安全与扩展性:提供会话隔离、模型与工具权限控制,以及可扩展的中间件式 Hook 体系,便于接入更多能力和工具。
-
安装步骤(示意,具体以仓库实际脚本为准)
- 安装依赖:在仓库根目录执行安装命令(如 bun install,或根据项目脚本使用 npm/yarn)。
- 构建发行包:执行构建步骤,将源码打包为可执行的 MCP 服务(参考仓库中的构建脚本或 package.json 脚本)。
- 启动 MCP 服务器:使用生成的可执行文件或入口脚本启动 MCP 服务器。示例路径通常类似 node dist/mcp-server.js 或 bun run start-mcp,具体以实际构建产物为准。
- 服务器自检与配置:启动后,MCP 服务器将注册内置 MCP 服务并暴露配置接口,请根据需要在本地或远端进行配置。
- 与 MCP 客户端连接:按照示例配置将 MCP 服务器信息填入 MCP 客户端配置中,以建立连接。
-
服务器配置(MCP 客户端需要的启动信息示意,JSON 格式,包含 server name、command、args 等,帮助 MCP 客户端与 MCP 服务器建立连接) { "servers": [ { "name": "omo-opencode-sisyphus-mcp", "command": ["node", "/path/to/oh-my-opencode/dist/mcp-server.js"], "args": ["--config", "/path/to/mcp-config.json"], "description": "Oh My OpenCode 内置 MCP 服务器(Sisyphus 协调器)", "enabled": true } ] }
注解说明:
- name: MCP 服务器的唯一名称,便于客户端区分与管理。
- command: 启动 MCP 服务器的命令及可执行文件或入口脚本。示例中使用 node 启动打包后的服务器。
- args: 启动服务器时需要的参数,通常包含指向 MCP 配置文件的路径等。
- description: 该 MCP 服务器的简短描述,便于运维和日志识别。
- enabled: 是否启用该 MCP 服务器。
- 以上信息仅为示意,实际部署请参考仓库内的 MCP 部署文档与生成的配置项。
-
基本使用方法
- 启动 MCP 服务器后,确保 MCP 客户端能够通过配置文件中的服务器信息找到并连接到 MCP 服务。
- 客户端向 MCP 服务器发送标准的 JSON-RPC 请求以读取资源、调用工具、获取 Prompt 模板等,服务器按 MCP 协议返回 JSON-RPC 响应或推送通知。
- 利用内置的会话与能力声明功能,确保在首次调用时,LLM 客户端能够获取可用资源与工具的清单,以及可用的 Prompt 模板信息。
- 如需扩展能力,可通过仓库提供的 MCP 加载/转换模块,将新的 MCP 配置注入到服务器能力集中。
-
注意事项
- MCP 服务器实现包含对 Claude Code MCP、Context7、websearch、grep 等内置 MCP 的支持与适配,便于在同一后端中托管多种 MCP 服务。
- 服务器端实现包含会话状态管理、能力声明、以及对传输协议的支持,确保在多种环境下稳定运行。
- 请在生产环境中遵循安全性与访问控制最佳实践,按需要对资源、工具与 prompts 进行权限控制。
信息
分类
AI与计算