AI导哈

MCP服务器模板

一个基于TypeScript/Node.js的MCP服务器开发模板，提供标准化结构和最佳实践，适用于构建模型上下文协议服务器。

  • by deachne
  • TypeScript
  • 本地部署
  • 更新于
在 GitHub 查看 deachne/mcp-server-template

使用说明

MCP服务器模板

使用TypeScript/Node.js构建模型上下文协议（MCP）服务器的综合模板。

概述

此模板为开发MCP服务器提供了标准化的结构和最佳实践。它包括：

  • 带有ES模块的TypeScript配置
  • 标准化目录结构
  • 错误处理实用程序
  • 测试框架
  • 示例实现
  • 全面的文件

快速开始

# Clone this repository
git clone https://github.com/your-org/mcp-server-template.git my-mcp-server

# Navigate to the project directory
cd my-mcp-server

# Install dependencies
npm install

# Build the project
npm run build

# Run the example server
npm start

LLM快速入门

此模板旨在与Claude等AI助手无缝协作，帮助您开发MCP服务器：

  1. 克隆此存储库：

    git clone https://github.com/your-org/mcp-server-template.git my-mcp-server
cd my-mcp-server

  2. 安装依赖项：

    npm install

  3. 从这些文件中复制提示，并将其粘贴到您与Claude或其他LLM的对话中：

    • PROMPT_TEMPLATE.md -有关MCP服务器的特定任务帮助
    • AI_ASSISTANT_PROMPT.md -用于设置具有深厚MCP专业知识的AI助手

  4. 填写有关您的特定MCP服务器要求的详细信息。

  5. 使用LLM实现您的自定义工具、资源和其他功能。

  6. 使用附带的测试工具测试您的实现：

    npm test

  7. 根据您的需要部署MCP服务器。

目录结构

mcp-server-template/
├── package.json           # Configured for ES modules
├── tsconfig.json          # TypeScript configuration
├── README.md              # Documentation with usage examples
├── PROMPT_TEMPLATE.md     # Template for task-specific LLM assistance
├── AI_ASSISTANT_PROMPT.md # Role prompt for MCP development assistant
├── DEVELOPMENT_RULES.md   # Development guidelines
├── src/
│   ├── index.ts           # Main server implementation
│   ├── tools/             # Example tool implementations
│   │   └── example-tool.ts
│   ├── resources/         # Example resource implementations
│   │   └── example-resource.ts
│   └── utils/             # Helper utilities
│       └── error-handling.ts
├── tests/                 # Test scripts
│   └── server.test.js
├── docs/                  # Detailed documentation
│   ├── client-developers.md
│   ├── server-developers.md
│   ├── claude-users.md
│   └── mcp-reference.md
└── examples/              # Example implementations
    ├── weather-server/    # Weather API example
    ├── github-server/     # GitHub API example
    └── local-files-server/ # Local file system example

特性

MCP服务器实现

该模板包括一个基本的MCP服务器实现，包括：

  • 协议版本协商
  • 能力声明
  • 工具注册和执行
  • 资源管理
  • 错误处理
  • 日志记录

工具与资源

示例实现：

  • 具有参数验证的基本工具
  • 带有URI模板的资源定义
  • 提示模板

测试

该模板包括一个测试框架，用于：

  • 单元测试工具和资源
  • 与MCP客户端的集成测试
  • 模拟外部依赖关系

文档

综合文档可在 docs/ 目录：

发展规律

请参考 开发_规则.md 关于以下方面的指导方针：

  • 模块系统使用
  • TypeScript最佳实践
  • 错误处理模式
  • 工具实施规则
  • 资源实施规则
  • 测试要求
  • 安全指南

例子

该模板包括几个示例实现：

  • 天气服务器：演示API与美国国家气象局的集成
  • GitHub服务器：显示如何与GitHub API集成
  • 本地文件服务器：说明文件系统访问和管理

贡献

欢迎投稿！请看 贡献.md 作为指导方针。

许可证

此项目根据MIT许可证获得许可-请参阅 许可证 文件以获取详细信息。

相关 MCP