使用说明(Markdown 格式)
-
项目简介
- 该仓库实现了一个用于 MCP(Model Context Protocol)的后端服务器,核心功能包括托管资源、注册并执行工具、以及定义渲染提示模板,旨在为大语言模型客户端提供结构化的上下文信息与能力调用。
-
主要功能点
- 资源管理:提供资源的列举与读取(如 CLAUDE.md、README.md、package.json 等的读取)。
- 工具注册与执行:拥有工具注册中心,客户端可通过 MCP 请求获取工具列表以及调用指定工具。
- Prompt/模板渲染:支持对提示模板与输入 schemas 的定义与渲染,方便与 LLM 的交互模式对齐。
- JSON-RPC 交互:实现标准的 MCP JSON-RPC 请求处理,包括 initialize、tools/list、resources/list、resources/read 等方法,以及错误处理。
- 会话与解析能力:服务器端负责会话管理、能力声明,并支持通过标准输入输出的传输方式(stdio)进行通信。
- 兼容性与扩展性:工具、资源、以及域对象均以模块化组织,便于扩展新的工具和资源。
-
安装与运行步骤
- 依赖与构建:在具备 Node.js 环境的机器上安装与构建相关依赖(项目包含 TypeScript/tsup 构建配置,能够打包成 dist 版本)。
- 启动方式(运输层为标准输入输出,通常与 Claude Code 集成):通过 Claude Code 的 MCP 集成入口启动服务器,示例命令为 Claude 配置中的启动命令,实际在本仓库中可通过 CLI 组件进行触发。参考说明:在 Claude Code 的集成中可以使用类似以下方式启动 MCP 服务:
- 通过 Claude Code 的 MCP 插件配置,在 CLAUDE 设置中将服务器启动命令设为 npx @anatolykoptev/krolik-cli mcp。
- 注意:MCP 服务器使用标准输入输出实现 JSON-RPC 通信,因此需要将客户端请求写入服务器的标准输入,服务器将输出响应到标准输出。
-
服务器配置(MCP 客户端需要的最小配置信息) 说明:MCP 客户端需要的配置包含服务器的启动命令及参数,以及服务器名称。以下为符合仓库信息的示例(JSON 格式,非代码块呈现): { "name": "krolik", "command": "npx", "args": ["@anatolykoptev/krolik-cli", "mcp"], "cwd": "<你的工作目录,例如 /path/to/项目根>" } 说明:
- name: MCP 服务器在客户端侧的标识名称,建议与项目名称保持一致。
- command: 启动 MCP 服务器的命令,此处使用 npx 调用 krolik-cli 的 mcp 子命令。
- args: 启动命令的参数,包含要执行的子命令(mcp)。
- cwd: 服务器在客户端需要工作时的工作目录,请替换为实际的项目根目录。
-
基本使用方法
- 步骤 1:确保 Node.js 版本满足仓库要求(Node.js 20 及以上)。
- 步骤 2:在 Claude Code 等环境中配置 MCP 服务器启动命令与参数(如上 JSON 配置所示)。
- 步骤 3:通过 MCP 客户端发起 JSON-RPC 请求,例如 initialize、tools/list、resources/list/read 等,以获取服务器能力、工具、资源等信息。
- 步骤 4:在后续对话中通过 tools/call 触发工具执行、resources/read 获取资源等,服务器返回标准的 JSON-RPC 响应内容。
- 步骤 5:若需要扩展,请按仓库中的模块化结构新增工具、资源类型、以及相应的 MCP 处理逻辑。
-
兼容性与拓展
- 服务器端实现了初始化、工具列表、工具调用、资源列表、资源读取等核心 MCP 请求,以及对未知方法的错误处理,具备基础的 MCP 服务能力。可以在现有基础上继续扩展更多资源类型、工具、和提示模板,以支持更丰富的 LLM 应用场景。
信息
分类
AI与计算