Actionbook MCP 服务器
使用说明(Markdown)
- 项目简介
- 该仓库实现了一个 MCP 服务器,用于向 MCP 客户端提供统一的上下文服务。核心职责包括托管资源 (Resources)、注册并执行工具 (Tools)、定义与渲染 Prompt 模板(Prompts),并通过 JSON-RPC 与客户端通信。服务器具备会话管理、能力声明,并支持多种传输协议(如 Stdio、SSE/HTTP),从而为 LLM 应用提供安全、可扩展的上下文服务框架。
- 主要功能点
- 资源管理与数据访问:通过 MCP 服务器对资源进行托管、查询与管理。
- 工具注册与执行:注册多种工具,例如搜索 Actionbook 条目、按 Area ID 获取行动详情、列出及搜索数据源等,客户端可调用执行。
- Prompt 模板定义与渲染:提供可渲染的提示模板,支持与 LLM 的灵活交互。
- JSON-RPC 协议通信:服务器通过标准的 JSON-RPC 进行请求/响应传输。
- 会话与能力声明:内置会话管理、能力声明和状态监控。
- 多传输协议支持:默认 STDIO,另可通过插件扩展如 SSE、WebSocket 等实现传输。
- 集成示例与测试:包含针对工具、API 客户端、协议版本等的集成与单元测试。
- 安装与运行(简要步骤)
- 直接通过 npm/npx 启动 MCP 服务器(仓库在包含 MCP 实现的多仓库结构中,通常以 npx 命令启动最新版本的 MCP 服务端)。
- 参考仓库中的“Option 2: MCP Server” 使用说明,将 MCP 服务器配置为与你的开发环境对接。
- 服务器配置(客户端连接所需信息,配置示例以 JSON 形式呈现)
- 服务器名称:actionbook
- 启动命令与参数(供 MCP 客户端连接配置使用,客户端无需修改代码,仅在配置中声明即可): { "server": { "name": "actionbook", "command": "npx", "args": ["-y", "@actionbookdev/mcp@latest"] } } 说明:
- name 表示服务器在客户端配置中的唯一标识。
- command 与 args 指向启动 MCP 服务器所需的可执行命令及参数,客户端据此建立连接。
- 注:MCP 客户端不需要实现服务器端的逻辑细节,只需要知道服务器的连接信息即可。
- 基本使用方法
- 启动服务器:使用上面给出的启动命令在你的环境中启动 MCP 服务器。
- 配置客户端连接:在你的 MCP 客户端设置中(如 IDE、工具链配置等),使用上述配置中的 server 信息,以将客户端连接到该 MCP 服务器。客户端仅需知道 server 的 name、command 和 args 即可实现连接,无需修改服务器端代码。
- 调用工具与读取资源:连接成功后,客户端可以通过 MCP JSON-RPC 调用注册的工具,如:
- search_actions(在 Actionbook 中检索行动手册)
- get_action_by_area_id(通过 Area ID 获取行动详情及其 DOM 选择器等)
- list_sources / search_sources(数据源相关查询)
- 运行与调试:服务端日志、测试用例与集成测试均可帮助你验证功能完整性与正确性。
- 备注
- MCP 服务器实现中包含多工具的注册、工具执行及错误处理逻辑,具备完整的测试覆盖,且具备与外部 API 的集成能力,能够服务于以 LLM 进行浏览器操作、数据查询与自动化任务的场景。