使用说明
项目简介
'create-typescript-server' 是一个命令行工具,旨在帮助开发者快速创建基于 TypeScript 的 MCP 服务器。它通过预定义的模板,自动生成 MCP 服务器项目的基础结构和配置文件,从而节省开发者搭建服务器的时间和精力。
主要功能点
- 快速脚手架: 一键生成 MCP 服务器项目,包含必要的代码结构和配置文件。
- 可配置服务器信息: 支持自定义服务器名称和描述。
- Claude.app 集成: 可选配置将新创建的 MCP 服务器添加到 Claude.app 的服务器列表中,方便在 Claude.app 中使用。
安装步骤
- 确保已安装 Node.js 和 npm。
- 打开终端,运行命令安装脚手架工具:'npm install -g @modelcontextprotocol/create-server'
服务器配置
此工具用于生成 MCP 服务器项目,生成的项目本身才是 MCP 服务器实现。MCP 客户端需要配置生成的 MCP 服务器的启动命令。 例如,如果生成的服务器项目目录为 'my-server',则 MCP 客户端的服务器配置(JSON 格式)可能如下:
{ "server name": "你的服务器名称", // 替换为你创建服务器时指定的名称 "command": "node", "args": ["/path/to/my-server/build/index.js"] // 替换为你的服务器项目 build 目录下的 index.js 文件的绝对路径 }
注意: '/path/to/my-server' 需要替换为你的服务器项目所在的实际路径。'你的服务器名称' 需要替换为你在创建服务器时指定的名称。
基本使用方法
- 在终端中,使用 'npx @modelcontextprotocol/create-server <你的服务器目录名>' 命令创建新的 MCP 服务器项目,例如 'npx @modelcontextprotocol/create-server my-new-mcp-server'。
- 根据提示输入服务器名称和描述等信息。
- 进入新创建的项目目录:'cd <你的服务器目录名>'。
- 安装项目依赖:'npm install'。
- 构建项目:'npm run build' 或 'npm run watch' (开发模式)。
- (可选) 将服务器链接到全局,方便运行:'npm link'。
- 启动生成的 MCP 服务器 (具体启动命令请参考生成的项目文档)。
- 在 MCP 客户端中配置连接到你启动的 MCP 服务器。
信息
分类
开发者工具