MCP Server Starter Typescript

🚀 MCP 服务器 TypeScript 启动模板

这是一个用于创建模型上下文协议 (MCP) 服务器的 TypeScript 启动模板。它提供了基本设置和样本工具实现，助您快速构建自己的 MCP 服务器。

🚀 快速开始

按照以下步骤创建您的 MCP 服务器：

# 创建项目目录
mkdir <project_name>
cd <project_name>

# 初始化新的 npm 项目
npm init -y

# 安装依赖项
npm install @modelcontextprotocol/sdk zod
npm install -D @types/node typescript

# 创建源代码目录和主文件
mkdir src
touch src/index.ts

✨ 主要特性

• 📝 TypeScript 配置
• ⚙️ 基本 MCP 服务器设置
• 🛠️ 样本工具实现
• 🛡️ 类型安全的开发环境

📦 安装指南

按照“快速开始”中的步骤，依次执行以下命令：

# 创建项目目录
mkdir <project_name>
cd <project_name>

# 初始化新的 npm 项目
npm init -y

# 安装依赖项
npm install @modelcontextprotocol/sdk zod
npm install -D @types/node typescript

# 创建源代码目录和主文件
mkdir src
touch src/index.ts

💻 使用示例

基础用法

# 创建项目目录
mkdir <project_name>
cd <project_name>

# 初始化新的 npm 项目
npm init -y

# 安装依赖项
npm install @modelcontextprotocol/sdk zod
npm install -D @types/node typescript

# 创建源代码目录和主文件
mkdir src
touch src/index.ts

高级用法

开发

1. 在 src/index.ts 中实现您的工具。
2. 构建项目：

npm run build

添加新工具

要添加新的工具，请使用 server.tool() 方法。示例：

server.tool(
  "tool-name",
  "tool-description",
  { 
    // 使用 Zod 方案定义您的工具参数
    param: z.string().describe("parameter description") 
  },
  async ({ param }) => {
    // 在此处实现您的工具逻辑
    return {
      content: [
        {
          type: "text",
          text: `工具已使用参数：${param}`,
        },
      ],
    };
  },
);

MCP 服务器配置

您可以在项目中配置多个 MCP 服务器。以下是示例配置：

{
    "mcpServers": {
        "<server_name>": {
            "command": "<command>",
            "args": [
                "--directory",
                "/ABSOLUTE/PATH/TO/PARENT/FOLDER/<project_name>",
                "run",
                "<script_name>"
            ]
        }
    }
}

此配置指定：

• <server_name>：MCP 服务器的唯一标识符
• command：运行脚本的命令（例如，python, node, uv)
• args：命令行参数数组
  • --directory：设置脚本的工作目录
  • 其他针对您的命令和脚本需求的特定参数

您可以添加更多服务器配置，只需在 mcpServers 对象中添加更多条目即可。

📚 详细文档

项目结构

.
├── src/
│   └── index.ts    # 主服务器实现
├── package.json    # 项目依赖项和脚本
└── tsconfig.json   # TypeScript 配置

📄 许可证

ISC