Boilerplate MCP Server

🚀 模板MCP服務器

模板MCP服務器是一個用於快速啟動和運行模型上下文協議（Model Context Protocol）項目的基線實現。它為開發者提供了標準化基礎架構，能讓開發者輕鬆構建、定製和發佈自定義的MCP服務器。

🚀 快速開始

運行服務器

# 開發模式
npm run dev

# 生產模式
npm start

# 帶調試的日誌
DEBUG=true npm run dev

✨ 主要特性

• 提供標準化基礎架構，便於開發者快速構建、定製和發佈自定義的MCP服務器。

📦 安裝指南

文檔未提及具體安裝步驟，可參考運行服務器部分的命令進行操作。

💻 使用示例

基礎用法

運行服務器

# 開發模式
npm run dev

# 生產模式
npm start

# 帶調試的日誌
DEBUG=true npm run dev

高級用法

調試工具 - MCP檢查器

1. 運行服務器：npm run dev
2. 打開瀏覽器訪問地址：http://localhost:5173
3. 在控制檯中測試你的工具並查看請求/響應詳細信息

📚 詳細文檔

項目結構

.
├── package.json          # 包管理文件
├── src/
│   ├── index.ts         # 入口點
│   └── tools/           # MCP工具定義目錄
│       └── example.tool.ts # 示例工具實現
├── cli/                 # 命令行接口目錄
│   └── example.cli.ts   # 示例CLI命令
└── types/               # 類型定義文件夾
    └── common.types.ts  # 公共類型定義

配置選項

{
    "boilerplate": {
        "environments": {
            "development": {
                "port": 3000,
                "host": "localhost"
            },
            "production": {
                "port": 80,
                "host": "your-domain.com"
            }
        },
        "logging": {
            "level": "debug",
            "disabled": false
        }
    }
}

發佈指南

當準備好發佈自定義MCP服務器時：

1. 更新package.json文件中的詳細信息
2. 更新README.md文件以包含你的工具文檔
3. 構建項目：npm run build
4. 測試生產構建：npm run start:server
5. 發佈到npm倉庫：npm publish

🔧 技術細節

為了保持向後兼容性，服務器還可以識別@aashari/boilerplate-mcp-server或無作用域的包名boilerplate-mcp-server下的配置，如果找不到boilerplate鍵。但是，推薦使用簡短的boilerplate鍵來定義新的配置。

📄 許可證

ISC許可證

{
    "boilerplate": {
        "environments": {
            "DEBUG": "true",
            "ANY_OTHER_CONFIG": "value"
        }
    }
}

⚠️ 重要提示

為了保持向後兼容性，服務器還可以識別@aashari/boilerplate-mcp-server或無作用域的包名boilerplate-mcp-server下的配置，如果找不到boilerplate鍵。但是，推薦使用簡短的boilerplate鍵來定義新的配置。