Create MCP Express

MCP Express服务器模板

使用Express.js快速构建新的模型上下文协议（MCP）服务器。

🎯 使用此存储库的两种方法

1.️⃣ 使用脚手架工具（推荐）

快速创建新的MCP服务器项目：

npx create-mcp-express my-mcp-server

这将：

• ✅ 使用所有模板文件创建新项目
• ✅ 设置TypeScript、Jest和所有依赖项
• ✅ 使用交互式提示配置您的项目
• ✅ 自动安装依赖项

2.️⃣ 克隆为模板

直接将此存储库用作起点：

git clone https://github.com/ahnafyy/mcp-poc.git my-mcp-server
cd my-mcp-server
rm -rf .git
git init
npm install

🏗️ 建筑

src/
├── config/          # Configuration management
├── constants/       # Application constants
├── registry/        # Tool & resource registration (Strategy Pattern)
├── resources/       # Resource handlers (functional)
├── server/          # Server creation and HTTP setup
├── tools/           # Tool handlers (functional)
├── types/           # TypeScript type definitions
├── utils/           # Utility functions (logger, etc.)
└── index.ts         # Application entry point
└── __tests__        # Tests for the app

🚀 入门指南

安装

npm install

发展

# Run in development mode
npm run dev

# Run with MCP inspector
npm run inspect

# Run both concurrently
npm run dev:inspect

生产

# Build
npm run build

# Start
npm start

🧪 测试

包含单元和集成测试的全面测试套件。

# Run all tests
npm test

# Run tests in watch mode
npm run test:watch

# Run with coverage report
npm run test:coverage

# Run with verbose output
npm run test:verbose

测试覆盖范围：

• 工具、资源、注册表和实用程序的单元测试
• HTTP和MCP服务器的集成测试
• 目标覆盖率：70%（语句、分支、函数、行）

看 测试.md 详细的测试策略。

🔍 检查员

抬头看 http://localhost:6274/ 与MCP服务器交互

📝 配置

通过环境变量进行配置：

SERVER_NAME=my-mcp-server
SERVER_VERSION=1.0.0
PORT=3000
NODE_ENV=development
LOG_LEVEL=info
LOG_COLORS=true
MCP_JSON_RESPONSE=true

🛠️ 添加新工具

工具使用具有明确类型定义的函数式方法：

// src/tools/my-custom.tools.ts
import { z } from 'zod';
import { Tool } from '../types/index.js';
import { logger } from '../utils/logger.js';

interface MyInput {
  value: string;
}

interface MyOutput {
  result: string;
}

const myHandler = async (input: MyInput) => {
  logger.debug('Executing my tool', { input });
  const result = { result: input.value.toUpperCase() };
  
  return {
    content: [{ type: 'text' as const, text: JSON.stringify(result) }],
    structuredContent: result,
  };
};

export const myTool: Tool = {
  name: 'my-tool',
  definition: {
    title: 'My Custom Tool',
    description: 'Does something useful',
    inputSchema: {
      value: z.string().describe('Input value'),
    },
  },
  handler: myHandler,
};

export const myTools = [myTool];

然后添加到 src/tools/index.ts:

export * from './my-custom.tools.js';

import { mathTools } from './math/math.tools.js';
import { myTools } from './my-custom.tools.js';

export const allTools = [...mathTools, ...myTools];

🗂️ 添加新资源

资源遵循相同的功能模式：

// src/resources/my-custom.resources.ts
import { Resource } from '../types/index.js';
import { logger } from '../utils/logger.js';

const myHandler = async (uri: URL, variables?: any) => {
  logger.debug('Fetching resource', { uri: uri.href });
  
  return {
    contents: [{
      uri: uri.href,
      mimeType: 'text/plain',
      text: 'My resource content',
    }],
  };
};

export const myResource: Resource = {
  name: 'my-resource',
  uri: 'custom://my-resource',
  definition: {
    title: 'My Custom Resource',
    description: 'Provides custom data',
  },
  handler: myHandler,
  isTemplate: false,
};

export const myResources = [myResource];

然后添加到 src/resources/index.ts:

export * from './my-custom.resources.js';

import { greetingResources } from './greeting/greeting.resources.js';
import { testResources } from './test/test.resources.js';
import { myResources } from './my-custom.resources.js';

export const allResources = [...testResources, ...greetingResources, ...myResources];