使用说明
🚀 MCP服务器DDD模板
此存储库是 模板实现 Node.js/TypeScript中的模型上下文协议(MCP)服务器,旨在使用领域驱动设计(DDD)原理演示一个干净的分层架构。它提供了通过外部API获取比特币相关信息的工具。
✨ 主要特点
- 🏗️ 模板项目: 此代码库可作为使用DDD构建MCP服务器的参考模板,可供定制和生产使用。
- 🔌 MCP协议: 通过以下方式进行沟通 标准 使用MCP协议(
@modelcontextprotocol/sdk). - 🏛️ 分层DDD架构: 域、应用程序、基础设施和接口层的明确分离。
- ⚡ TypeScript: 完全使用现代TypeScript类型,以获得更好的开发体验。
📁 项目结构
src/
├── domain/ # 🏛️ Domain models and response interfaces
│ └── models/
│ └── responses/
│ ├── ** interfaces responses **
├── infrastructure/ # 🔌 External API clients and request services
│ ├── interfaces/
│ │ └── IApiClient.ts
│ └── services/
│ ├── clients/
│ │ └── ** client api
│ └── requests/
│ ├── ** requests services **
├── application/ # ⚙️ Business logic and helpers
│ ├── services/
│ │ ├── ** services implementation **
│ └── helpers/
│ └── ** helpers **
├── interface/ # 🎮 Controllers (MCP tool registration)
│ └── controllers/
│ ├── base/
│ │ └── BaseToolsController.ts
│ ├── **controllers to inteface**
│ └── index.ts
├── shared/ # 🔗 Shared types/parameters
│ └── parameters/
│ └── **interfaces parameters**
└── main.ts # 🚀 Application entry point
🚀 入门指南
git clone https://github.com/alexandresanlim/mcp-server-ddd-template.git
cd mcp-server-ddd-template
npm install
npm run build
🎯 用法
构建后,您可以直接运行服务器:
node build/main.js
或者如果注册为二进制(例如, mcp-server-ddd-template):
npm link
mcp-server-ddd-template
服务器将以标准输出启动(标准)并等待MCP请求。
🛠️ 此示例中的可用工具
- 💰 获得推荐费用:从Mempool.space获取推荐的比特币交易费用
- 🔗 拼:简单的健康检查终点
🔗 集成示例
要将此MCP服务器用作客户端(例如Claude客户端)中的工具提供者,您可以引用本地构建或使用已发布的npm包。
📂 使用本地构建路径
"btc-server": {
"command": "node",
"args": [
"{your project path}/mcp-server-ddd-template/build/main.js"
]
}
🛠️ 发展
构建命令
# Build for Unix/Linux/macOS
npm run build
# Build for Windows
npm run build:windows
# Run the server
npm run server
依赖项
- @模型上下文协议/sdk:MCP协议实施
- 动物圈:运行时类型验证
- 打字稿:类型安全和编译
🤝 贡献
欢迎拉取请求!请随时打开此模板存储库的问题或提出改进建议。
⭐ 如果您觉得此存储库有用,请将其标记为星号!
