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键来定义新的配置。