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