Sigil Model Context Protocol (MCP) Server
使用说明 (Markdown 格式)
-
项目简介
- Sigil 的 MCP 服务器实现,作为后端服务,负责托管和管理 Resources(资源)、Tools(工具)以及 Prompts(提示模板),并通过 JSON-RPC 协议与 LLM 客户端通信,支持向量化查询、工具执行、以及上下文渲染等能力。
- 服务器端核心职责包括:资源与工具的注册与执行、Prompt 模板的定义与渲染、以及会话与能力声明等。实现基于 MCP 标准的请求/响应模式,兼容多种传输方式。
-
主要功能点
- 注册与执行 Tools:提供一组 MCP Tool,允许 LLM 客户端发起 tool 调用请求并获取结果。
- 资源与上下文托管:支持资源管理数据访问,为 LLM 提供可复用的上下文信息。
- Prompts 与渲染:定义与渲染 Prompt 模板,便于不同交互模式下的上下文生成。
- JSON-RPC 通信:遵循 MCP 的 JSON-RPC 交互规范,处理请求并返回标准化的 JSON-RPC 响应。
- 客户端集成示例:提供与 Claude Code/MCP 客户端的对接思路(通过 MCP 配置连接到服务器)。
-
安装步骤
- 在仓库内定位到插件的 MCP 服务器实现目录(插件路径通常为 plugins/mcp-server)。
- 安装依赖并构建分发产物:
- 进入插件目录,执行依赖安装与构建命令,生成 dist/index.js(或等效可执行入口)。
- 将生成的 MCP 服务器可执行文件部署到运行环境中,确保服务器具备对外暴露的通信端口。
-
服务器配置(MCP 客户端需要的配置信息,示例以 JSON 表达)
- 服务器名称(server name):sigil
- 启动命令(command):node
- 启动参数(args):/path/to/插件/mcp-server/dist/index.js 具体配置信息示例(MCP 客户端配置格式,JSON 表达,供客户端连接使用,非代码块): { "mcpServers": { "sigil": { "server_name": "sigil", "command": "node", "args": ["/path/to/sigil/plugins/mcp-server/dist/index.js"] } // 若有多实例,可按需扩展 } } 注释:
- server_name 对应 MCP 服务器在客户端侧的标识名称,通常与 MCP 服务器实例的名称一致。
- command/a rgs 指向实际可执行的 MCP 服务入口文件(dist/index.js 为构建产物路径,请根据实际部署路径填写)。
- MCP 客户端仅需要该配置信息以建立与 MCP 服务器的连接与对话渠道,不需要在此处暴露更多实现细节。
-
基本使用方法
- 启动后,MCP 客户端可通过 MCP 协议发送请求来读取资源、调用工具、渲染 Prompt 等,服务器返回标准的 JSON-RPC 响应。
- 客户端可通过配置中的 server_name 与命令参数建立连接,发起诸如工具调用、资源查询、Prompt 获取等操作。
- 服务端应具备会话管理、能力声明以及对接外部 LLM 的能力扩展能力,以实现安全、可扩展的上下文服务框架。
-
免责声明与注意
- MCP 客户端对接时,请确保网络安全策略、鉴权与权限控制符合你的使用场景要求。
- 服务器端实现需定期更新能力声明与安全策略,以应对新的工具与上下文需求。
-
参考信息
- 代码所在路径:plugins/mcp-server/src/index.ts(MCP 服务核心实现,注册工具、资源与响应格式等)
- 服务器名称示例:sigil,版本信息在实现中可按实际发布进行更新