MCP 服务器

generic-mcp-server

一个框架，可以与人工智能一起使用，轻松地为任何服务创建服务器。只需将 API 文档放入其中，然后要求创建 MCP（最小可行产品）。 Alternatively, depending on the context, MCP could also stand for "Minimum Complete Product". In that case, the translation would be: 一个框架，可以与人工智能一起使用，轻松地为任何服务创建服务器。只需将 API 文档放入其中，然后要求创建最小完整产品。

AI集成系统

访问服务器

README

通用 MCP 服务器模板

一个模块化、可扩展的模型上下文协议 (MCP) 服务器模板，旨在方便定制和扩展。

特性

模块化架构: 职责清晰分离，结构良好定义
小型、专注的文件: 更好的可维护性，更易于 AI 摄取
易于扩展的接入点: 用于添加新工具和服务的简单模式
全面的错误处理: 贯穿整个代码库的强大错误管理
类型安全: 完整的 TypeScript 支持，具有适当的类型

项目结构

generic-mcp-template/
├── src/
│   ├── services/       # 用于 API 交互的服务类
│   │   ├── base-service.ts        # 具有通用功能的抽象基类服务
│   │   └── example-service.ts     # 示例服务实现
│   ├── tools/          # MCP 工具定义和处理程序
│   │   ├── example-tools.ts       # 工具定义（名称、描述、模式）
│   │   └── example-tool-handlers.ts # 工具处理程序实现
│   ├── types/          # TypeScript 类型定义
│   │   └── example-types.ts       # 示例类型定义
│   ├── config.ts       # 配置管理
│   └── index.ts        # 主入口点
├── .env.example        # 示例环境变量
├── package.json        # 项目依赖和脚本
├── tsconfig.json       # TypeScript 配置
└── README.md           # 项目文档

快速开始

前提条件

Node.js 18 或更高版本
npm 或 yarn

安装

克隆此存储库：

git clone https://github.com/v4lheru/generic-mcp-template.git
cd generic-mcp-template

安装依赖项：
```
npm install
```
基于 .env.example 创建一个 .env 文件：
```
cp .env.example .env
```
使用您的 API 密钥和配置编辑 .env 文件。

构建和运行

构建项目：
```
npm run build
```
运行服务器：
```
npm start
```

扩展模板

添加新服务

在 src/services/ 中创建一个新的服务文件：

// src/services/my-service.ts
import { BaseService } from './base-service.js';
import config from '../config.js';

export class MyService extends BaseService {
    // 实现您的服务...
}

在 src/types/ 中添加任何必要的类型。

添加新工具

在新文件中定义您的工具，或扩展 src/tools/ 中的现有工具：

// src/tools/my-tools.ts
export const myTools = [
    {
        name: "my_tool",
        description: "我的工具的描述",
        inputSchema: {
            // 工具输入的 JSON Schema
        }
    }
];

实现您的工具的处理程序：

// src/tools/my-tool-handlers.ts
import { MyService } from '../services/my-service.js';

export function createMyToolHandlers(myService: MyService) {
    return {
        my_tool: async (args: any) => {
            // 实现您的工具处理程序
        }
    };
}