MCP Server TypeScript Starter

MCP Server TypeScript Starter

这是一个使用 TypeScript 创建 Model Context Protocol（MCP）服务的入门模板。它提供了基础设置和示例工具实现，帮助你开始构建自己的 MCP 服务。

功能

• TypeScript 配置
• 基础 MCP 服务设置
• 示例工具实现
• 类型安全的开发环境

开始使用

按照以下步骤创建自己的 MCP 服务：

# Create a new directory for your project
mkdir <project_name>
cd <project_name>

# Initialize a new npm project
npm init -y

# Install dependencies
npm install @modelcontextprotocol/sdk zod
npm install -D @types/node typescript

# Create source directory and main file
mkdir src
touch src/index.ts

项目结构

.
├── src/
│   └── index.ts    # Main server implementation
├── package.json    # Project dependencies and scripts
└── tsconfig.json   # TypeScript configuration

开发

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

   npm run build
   

添加新工具

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

server.tool(
  "tool-name",
  "tool-description",
  { 
    // Define your tool's parameters using Zod schema
    param: z.string().describe("parameter description") 
  },
  async ({ param }) => {
    // Implement your tool logic here
    return {
      content: [
        {
          type: "text",
          text: `Tool executed with parameter: ${param}`,
        },
      ],
    };
  },
);

MCP Server 配置

你可以在项目中配置多个 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 对象添加更多条目来配置多个服务。

许可证

ISC