使用说明(Markdown格式):
-
项目简介
- 该仓库实现了基于 MCP 的服务端,能够注册、暴露并执行工具(Tools)、资源(Resources)以及提示模板(Prompts),并通过 JSON-RPC 与客户端进行通信。内含多种传输实现(如 STDIO、浏览器传输、Chrome 扩展等),并提供在浏览器环境中运行的服务器变体,便于在 Web 场景下为 AI 客户端提供浏览上下文和能力。
-
主要功能点
- MCP 服务器核心:注册、执行工具,返回结构化输出或文本输出,支持可选的 outputSchema 以提供 structuredContent。
- 资源、工具、提示的注册与管理:支持在连接后动态注册工具、资源与 prompts,并在断开/重新连接时保持一致性。
- 多传输协议支持:随同服务器提供多个传输实现(STDIO、Tab/Extension/Iframe 等),实现服务器与客户端的跨进程/跨上下文通信。
- 浏览器本地实现(BrowserMcpServer):在浏览器环境中提供动态注册能力,适合 Web 场景的 MCP 服务端实现。
- 开发工具集成:提供大量工具(调试、网络、性能、截图、脚本执行、WebMCP 集成等),并有完整的类型定义与文档注释。
- 配置化与可扩展性:通过 TypeScript 定义工具、输入输出模式、回调、格式化输出等,便于扩展与定制。
- 日志与诊断:内置日志框架,支持将日志输出到文件,便于排错和审计。
-
安装步骤
- 先决条件:Node.js 环境,推荐使用仓库提供的工作区构建方式(如 pnpm)。
- 安装依赖并构建:
- 安装依赖并构建整个仓库(推荐在仓库根目录执行,以利用工作区);
- 运行构建命令生成可执行的服务端代码(如 build 输出)。
- 运行服务器:
- 通过 Node 直接运行构建产物,例如执行生成的入口脚本(如 build/src/main.js 或等效入口),使 MCP 服务器启动并监听客户端连接。
- 连接客户端:
- MCP 客户端需要与你的服务器建立连接,至少配置服务器名称、启动命令及参数等(下面给出示例配置 JSON)。
- 客户端需要使用相应传输层(如 STDIO、WebSocket、Tab、Iframe 等)来与服务器进行 JSON-RPC 通信。
-
服务器配置(示例,JSON 格式,请据实际环境调整) 说明:以下配置用于 MCP 客户端连接到该服务端。字段含义见注释。请根据仓库信息生成准确的配置信息与参数注释。服务器的启动命令通常由客户端通过 StdioServerTransport 或相应传输在本地运行时提供。 { "serverName": "chrome_devtools", "command": "node", "args": ["build/src/index.js"], "description": "Chrome DevTools MCP 服务端,提供 Tools、Resources、Prompts 的注册与执行,供 MCP 客户端通过 JSON-RPC 进行交互", "notes": "启动后客户端通过 STDIO/其他传输方式连接,并可访问工具集合与上下文数据。" }
-
基本使用方法
- 启动服务器:在构建产物所在的目录下执行应用启动命令,确保依赖已安装。
- 客户端连接:使用相应传输(如 STDIO)将客户端连接到服务器,按照 MCP 客户端文档配置连接参数。
- 使用工具与上下文:通过注册工具、查询资源、获取 prompts 等,LLM 客户端即可调用服务器提供的能力,服务器将返回 MCP 规定的响应格式(文本/结构化内容等)。
- 部署与扩展:可以在浏览器环境中使用 BrowserMcpServer 变体,或通过不同传输实现扩展服务器能力,便于在前端应用、浏览器插件等场景应用。
-
额外说明
- 该仓库包含了对 MCP 协议的完整实现与示例(核心服务器、传输实现、工具集、浏览器端服务器变体等),适合作为正式的 MCP 服务端解决方案。
信息
分类
AI与计算