项目简介
该仓库提供了一个灵活的模板,用于构建遵循Model Context Protocol (MCP) 的服务器。MCP协议使得AI助手(如Claude Desktop)能够与本地运行的服务进行通信,从而获取额外信息和调用本地功能。这个模板使用官方的TypeScript SDK构建,确保类型安全和模块化设计,方便开发者在此基础上快速创建自己的MCP服务器。
主要功能点
- 本地资源托管:提供对本地系统信息(如操作系统、Node.js版本、运行时间)和应用配置的访问。AI助手可以通过URI获取这些结构化数据。
- 本地工具调用:允许AI助手调用服务器上注册的特定功能。例如,模板中提供了“计算两数之和”和“获取城市天气预报(模拟)”等工具。
- Stdio传输:通过标准输入/输出流进行通信,适合本地AI助手代理集成,无需启动HTTP服务器。
- 模块化设计:易于扩展,用户可以轻松添加新的资源和工具来满足特定需求。
安装步骤
在开始之前,请确保您的系统已安装 Node.js (v16 或更高版本) 和 npm 或 yarn。
- 克隆仓库:
git clone https://github.com/v4lheru/generic-mcp-template.git cd generic-mcp-template - 安装依赖:
npm install - 构建项目:
这会将TypeScript源代码编译为JavaScript,生成可执行文件在 'dist' 目录下。npm run build
服务器配置
MCP服务器通常由AI客户端(如Claude Desktop)启动和管理。您需要将MCP服务器的启动信息配置到AI客户端中。以下是一个示例配置,以JSON格式提供:
{ "mcpServers": { "my-local-mcp-server": { "command": "node", "args": ["/path/to/your/generic-mcp-template/dist/index.js"] } } }
- 'my-local-mcp-server': 这是您为该MCP服务器定义的唯一名称,AI客户端将使用此名称来引用它。
- 'command': 启动MCP服务器所使用的命令或可执行文件。对于这个基于Node.js的项目,通常是 'node'。
- 'args': 一个字符串数组,包含传递给 'command' 的参数。这里需要指定您刚刚构建好的MCP服务器的入口文件路径。请将 '/path/to/your/generic-mcp-template/dist/index.js' 替换为实际的文件路径。
例如,在macOS上,您可能需要编辑 '~/Library/Application Support/Claude/claude_desktop_config.json' 文件来添加此配置。
基本使用方法
配置完成后,当AI客户端需要访问您的MCP服务器提供的功能时,它会自动启动该服务器并与之通信。您也可以在开发或测试阶段手动运行服务器:
npm run start
服务器将通过标准输入/输出运行,它不会启动HTTP服务器,并会在控制台输出“Generic MCP Server running on stdio”消息。您可以通过向其标准输入发送MCP协议兼容的JSON-RPC请求来测试它,或将其集成到兼容的AI助手中。
信息
分类
开发者工具