AtomCLI MCP 服务器
使用说明(简要、可操作)
-
项目简介
- 这是一个在 AtomCLI 框架内实现的 MCP 服务器组件,核心职责是以统一的 JSON-RPC 方式向 LLM 客户端暴露可访问的资源数据、可执行的工具,以及可渲染的提示模板,帮助聊生成模型获取上下文与功能能力。
- 服务器具备会话管理、能力声明,以及对多种传输协议的支持,便于嵌入到不同的后端场景中(本地 STDIO、Server-Sent Events、WebSocket 等)。
-
主要功能点
- 资源与数据访问:托管可供模型访问的资源集合,便于在对话中读取、写入或查询。
- 工具注册与执行:注册可被模型调用的外部功能,以及在需要时执行这些工具。
- 提示模版与渲染:定义和渲染可定制的 Prompt 模板,配合对话模式提供上下文信息。
- JSON-RPC 通信:通过标准的 JSON-RPC 协议与 MCP 客户端进行请求/响应交互。
- 会话与能力声明:服务器端负责会话状态管理,并声明自身能力,例如支持的资源类型、工具、模板等。
- 多传输协议支持:支持 Stdio、SSE、WebSocket 等传输方式,方便在不同部署环境中工作。
-
安装步骤(简化版)
- 安装依赖:在项目根目录执行适用于你环境的包管理命令(如 bun、npm 等)以安装依赖。
- 构建/启动 MCP 服务器:在构建完成后,通过项目提供的命令启动 MCP 服务,确保服务器能够对外接收 JSON-RPC 请求并进行处理。
- 配置 MCP 服务器:将 MCP 服务器注册到客户端配置中(见下方服务器配置示例)。确保客户端能够通过指定的启动命令与参数建立连接。
- 测试运行:使用 MCP 客户端向服务器发起读取资源、执行工具、获取 Prompts 等请求,观察返回的 JSON-RPC 响应。
-
服务器配置示例(JSON,仅用于 MCP 客户端参考;客户端实际调用不需要此配置) { "serverName": "memory-bank", "command": "atomcli", "args": ["mcp", "start", "memory-bank"], "description": "Memory-backed MCP server for context/resources", "transport": { "type": "stdio", "options": {} }, "endpoints": { "resources": "/memory-bank/resources", "tools": "/memory-bank/tools", "prompts": "/memory-bank/prompts" } }
说明:
- serverName:标识 MCP 服务器的名称,方便客户端和管理工具识别。
- command/args:用于启动服务器的命令及参数,客户端通过该信息建立连接(请按实际实现填写准确的启动方式与参数)。
- transport:首选传输方式及相关选项,支持多种实现(如 Stdio、SSE、WebSocket)。
- endpoints:服务器提供的主要能力入口(资源、工具、Prompts 的访问入口路径或标识)。 注:以上配置为参考格式,实际部署请以仓库提供的实现方式为准,确保 MCP 客户端能正确连接并进行 JSON-RPC 请求。
-
基本使用方法
- 启动服务器:按照配置命令启动 MCP 服务器进程。
- 客户端连接:MCP 客户端通过统一的 JSON-RPC 通道与服务器通信,发送请求如“读取资源”、“执行工具”、“获取 Prompt”等,并接收相应的 JSON-RPC 响应。
- 会话与能力:服务器在会话开始时声明自身能力,并在运行时处理资源与工具相关的请求,确保上下文服务可扩展、安全可控。
- 运行环境与扩展:支持多传输协议,便于嵌入到 TUI、后端服务或嵌入式环境中;便于未来扩展更多资源类型与工具。
-
额外说明
- 该实现基于 AtomCLI 框架,结合 MCP 的资源/工具/提示模板管理能力,具有可扩展性和本地化控制特性,便于将 LLM 与本地环境进行深度结合。
- 文档与测试表明仓库内已有 MCP 模块与相关测试覆盖,支持通过 CLI/配置进行 MCP 服务器的注册与管理,以及对传输头部进行协调处理。
- 关键词:Model Context Protocol, JSON-RPC, 资源管理, 工具注册, 提示模板, 多传输协议
- 分类ID: 6