@claude-flow/mcp

中文文档
3.1.7发布于 2026/11/09TypeScriptES Module近 30 天下载 2.9万

Standalone MCP (Model Context Protocol) server - stdio/http/websocket transports, connection pooling, tool registry

原始使用文档
文档目录26 节
  1. Quickstart
  2. Features
  3. Installation
  4. Quick Start
  5. Transports
  6. Stdio (Default)
  7. HTTP
  8. WebSocket
  9. Tool Registry
  10. Session Management
  11. Connection Pool
  12. API Reference
  13. Server
  14. Tool
  15. Transport
  16. Built-in Tools
  17. Resources (MCP 2025-11-25)
  18. Prompts (MCP 2025-11-25)
  19. Tasks (MCP 2025-11-25)
  20. MCP Methods Supported
  21. Performance Targets
  22. Security
  23. Authentication
  24. CORS
  25. Error Codes
  26. License

@claude-flow/mcp

Animated diagram: an MCP client request travels through a transport and the MCPServer to the ToolRegistry and the tool handler

@claude-flow/mcp — A standalone Model Context Protocol server: stdio, HTTP and WebSocket transports, a schema-checked tool registry, resources, prompts and tasks.

Supported environments: Node.js 20+ · ESM · Linux, macOS, Windows (pure JavaScript)

Quickstart

npm install @claude-flow/mcp
import { createToolRegistry, defineTool } from '@claude-flow/mcp';

const logger = { debug() {}, info() {}, warn: console.warn, error: console.error };
const registry = createToolRegistry(logger);
registry.register(defineTool('echo', 'Echo the input text', {
  type: 'object', properties: { text: { type: 'string' } }, required: ['text'],
}, async ({ text }) => ({ echoed: text })));
console.log(registry.getToolNames());
const result = await registry.execute('echo', { text: 'hi' });
console.log(result.isError ?? false, result.content[0].text);

Expected output:

[ 'echo' ]
false {
  "echoed": "hi"
}

Used by @claude-flow/cli, which serves the Ruflo tools over this server.

npm version npm downloads License: MIT TypeScript MCP 2025-11-25 Standalone

MCP 2025-11-25 Compliant - Standalone Model Context Protocol server implementation with full Resources, Prompts, and Tasks support

Features

  • MCP 2025-11-25 Compliant - Full specification support
  • High-Performance Server - <400ms startup time
  • Multiple Transports - stdio, HTTP, WebSocket, in-process
  • Resources - list, read, subscribe with caching
  • Prompts - templates with arguments and embedded resources
  • Tasks - Async operations with progress and cancellation
  • Pagination - Cursor-based pagination for large datasets
  • Connection Pooling - Max 10 connections, configurable
  • Fast Tool Registry - O(1) lookup, <10ms registration
  • Session Management - Timeout handling, authentication
  • Security - CORS, Helmet, auth tokens
  • Zero Dependencies - No @claude-flow/* dependencies

Installation

npm install @claude-flow/mcp

Quick Start

import { quickStart, defineTool } from '@claude-flow/mcp';

// Create and start server
const server = await quickStart({
  transport: 'stdio',
  name: 'My MCP Server',
});

// Register custom tools
server.registerTool(defineTool(
  'greet',
  'Greet a user',
  {
    type: 'object',
    properties: {
      name: { type: 'string', description: 'User name' }
    },
    required: ['name']
  },
  async ({ name }) => ({ message: `Hello, ${name}!` })
));

// Start listening
await server.start();

Transports

Stdio (Default)

import { createMCPServer } from '@claude-flow/mcp';

const server = createMCPServer({
  transport: 'stdio',
  name: 'Stdio Server',
}, logger);

await server.start();

HTTP

const server = createMCPServer({
  transport: 'http',
  host: 'localhost',
  port: 3000,
  corsEnabled: true,
  corsOrigins: ['http://localhost:8080'],
  auth: {
    enabled: true,
    method: 'token',
    tokens: ['secret-token'],
  },
}, logger);

await server.start();
// Server at http://localhost:3000
// WebSocket at ws://localhost:3000/ws

WebSocket

const server = createMCPServer({
  transport: 'websocket',
  host: 'localhost',
  port: 3001,
  maxConnections: 100,
  heartbeatInterval: 30000,
}, logger);

await server.start();
// WebSocket at ws://localhost:3001/ws

Tool Registry

import { createToolRegistry, defineTool } from '@claude-flow/mcp';

const registry = createToolRegistry(logger);

// Register tool
registry.register({
  name: 'calculate',
  description: 'Perform calculations',
  inputSchema: {
    type: 'object',
    properties: {
      expression: { type: 'string' }
    }
  },
  handler: async ({ expression }) => {
    return { result: eval(expression) };
  },
  category: 'math',
  tags: ['calculator'],
});

// Execute tool
const result = await registry.execute('calculate', { expression: '2 + 2' });

// Search tools
const mathTools = registry.getByCategory('math');
const stats = registry.getStats();

Session Management

import { createSessionManager } from '@claude-flow/mcp';

const sessions = createSessionManager(logger, {
  maxSessions: 100,
  sessionTimeout: 30 * 60 * 1000, // 30 minutes
});

// Create session
const session = sessions.createSession('http');

// Initialize with client info
sessions.initializeSession(session.id, {
  protocolVersion: '2024-11-05', // MCP spec: YYYY-MM-DD string
  capabilities: { tools: { listChanged: true } },
  clientInfo: { name: 'Claude', version: '1.0' },
});

// Get metrics
const metrics = sessions.getSessionMetrics();
// { total: 1, active: 1, authenticated: 0, expired: 0 }

Connection Pool

import { createConnectionPool } from '@claude-flow/mcp';

const pool = createConnectionPool({
  maxConnections: 10,
  minConnections: 2,
  idleTimeout: 30000,
  acquireTimeout: 5000,
}, logger, 'http');

// Acquire connection
const conn = await pool.acquire();

// Use connection...

// Release back to pool
pool.release(conn);

// Get stats
const stats = pool.getStats();
// { totalConnections: 5, idleConnections: 4, busyConnections: 1, ... }

API Reference

Server

interface IMCPServer {
  start(): Promise<void>;
  stop(): Promise<void>;
  registerTool(tool: MCPTool): boolean;
  registerTools(tools: MCPTool[]): { registered: number; failed: string[] };
  getHealthStatus(): Promise<{ healthy: boolean; error?: string; metrics?: Record<string, number> }>;
  getMetrics(): MCPServerMetrics;
  getSessions(): MCPSession[];
  getSession(sessionId: string): MCPSession | undefined;
  terminateSession(sessionId: string): boolean;
}

Tool

interface MCPTool<TInput = unknown, TOutput = unknown> {
  name: string;
  description: string;
  inputSchema: JSONSchema;
  handler: (input: TInput, context?: ToolContext) => Promise<TOutput>;
  category?: string;
  tags?: string[];
  cacheable?: boolean;
  cacheTTL?: number;
  timeout?: number;
}

Transport

interface ITransport {
  readonly type: TransportType;
  start(): Promise<void>;
  stop(): Promise<void>;
  onRequest(handler: RequestHandler): void;
  onNotification(handler: NotificationHandler): void;
  sendNotification?(notification: MCPNotification): Promise<void>;
  getHealthStatus(): Promise<TransportHealthStatus>;
}

Built-in Tools

The server automatically registers these system tools:

ToolDescription
system/infoGet server information
system/healthGet health status
system/metricsGet server metrics
tools/list-detailedList all tools with details

Resources (MCP 2025-11-25)

import { createMCPServer, createTextResource } from '@claude-flow/mcp';

const server = createMCPServer({ transport: 'stdio' }, logger);
const resourceRegistry = server.getResourceRegistry();

// Register a text resource
const { resource, handler } = createTextResource(
  'file://readme.txt',
  'README',
  'Welcome to the application!',
  { mimeType: 'text/plain' }
);
resourceRegistry.registerResource(resource, handler);

// Register with custom handler
resourceRegistry.registerResource(
  {
    uri: 'db://users/{id}',
    name: 'User Data',
    description: 'Get user by ID',
    mimeType: 'application/json',
  },
  async (uri) => {
    const id = uri.split('/').pop();
    const user = await fetchUser(id);
    return [{ uri, mimeType: 'application/json', text: JSON.stringify(user) }];
  }
);

// Subscribe to updates
resourceRegistry.subscribe('file://readme.txt', (uri, content) => {
  console.log('Resource updated:', uri);
});

Prompts (MCP 2025-11-25)

import { createMCPServer, definePrompt, textMessage, interpolate } from '@claude-flow/mcp';

const server = createMCPServer({ transport: 'stdio' }, logger);
const promptRegistry = server.getPromptRegistry();

// Define a prompt with arguments
const codeReviewPrompt = definePrompt(
  'code_review',
  'Review code for quality and best practices',
  async (args) => [
    textMessage('user', `Please review this ${args.language} code:\n\n${args.code}`),
  ],
  {
    title: 'Code Review',
    arguments: [
      { name: 'code', description: 'The code to review', required: true },
      { name: 'language', description: 'Programming language', required: false },
    ],
  }
);

promptRegistry.register(codeReviewPrompt);

// Get prompt with arguments
const result = await promptRegistry.get('code_review', {
  code: 'function hello() { return "world"; }',
  language: 'JavaScript',
});

Tasks (MCP 2025-11-25)

import { createMCPServer } from '@claude-flow/mcp';

const server = createMCPServer({ transport: 'stdio' }, logger);
const taskManager = server.getTaskManager();

// Create a long-running task
const taskId = taskManager.createTask(async (reportProgress, signal) => {
  for (let i = 0; i <= 100; i += 10) {
    if (signal.aborted) throw new Error('Task cancelled');

    reportProgress({
      progress: i,
      total: 100,
      message: `Processing... ${i}%`,
    });

    await new Promise(r => setTimeout(r, 100));
  }

  return { success: true, processedItems: 100 };
});

// Get task status
const status = taskManager.getTask(taskId);

// Wait for completion
const result = await taskManager.waitForTask(taskId);

// Cancel a task
taskManager.cancelTask(taskId, 'User requested cancellation');

MCP Methods Supported

MethodDescription
initializeInitialize connection
tools/listList available tools
tools/callExecute a tool
resources/listList resources with pagination
resources/readRead resource content
resources/subscribeSubscribe to updates
resources/unsubscribeUnsubscribe from updates
prompts/listList prompts with pagination
prompts/getGet prompt with arguments
tasks/statusGet task status
tasks/cancelCancel a running task
completion/completeAuto-complete arguments
logging/setLevelSet log level
pingKeep-alive

Performance Targets

MetricTarget
Server startup<400ms
Tool registration<10ms
Tool execution overhead<50ms
Connection acquire<5ms
Connection release<1ms

Security

Authentication

const server = createMCPServer({
  auth: {
    enabled: true,
    method: 'token',
    tokens: ['your-secret-token'],
  },
}, logger);

CORS

const server = createMCPServer({
  transport: 'http',
  corsEnabled: true,
  corsOrigins: ['https://your-domain.com'],
}, logger);

Error Codes

const ErrorCodes = {
  PARSE_ERROR: -32700,
  INVALID_REQUEST: -32600,
  METHOD_NOT_FOUND: -32601,
  INVALID_PARAMS: -32602,
  INTERNAL_ERROR: -32603,
  SERVER_NOT_INITIALIZED: -32002,
  AUTHENTICATION_REQUIRED: -32001,
};

License

MIT


Built by rUv · ruv.io · Source

版本与发布记录

@claude-flow/mcp 共发布 14 个版本,首次发布于 2026/01/07;过去 12 个月发布了 14 个版本。

版本发布日期距今
3.1.7latest2026/11/09今天
3.1.62026/11/045 天前
3.1.52026/11/019 天前
3.1.42026/10/2714 天前
3.1.32026/10/2614 天前
3.1.22026/10/2317 天前

其他发布通道:alpha → 3.0.0,v3alpha → 3.0.0。

关于 @claude-flow/mcp 的常见问题

@claude-flow/mcp 是什么?

Standalone MCP (Model Context Protocol) server - stdio/http/websocket transports, connection pooling, tool registry

如何安装 @claude-flow/mcp?

在项目目录运行 npm install @claude-flow/mcp,或使用 pnpm add / yarn add / bun add。

@claude-flow/mcp 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@claude-flow/mcp 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@claude-flow/mcp 可以商用吗?

@claude-flow/mcp 使用 未声明 许可。package.json 没有声明许可证。没有许可证的代码默认保留全部权利,商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括,不构成法律意见,请以许可原文为准。

@claude-flow/mcp 的下载量有多少?

根据 npm 官方下载统计,@claude-flow/mcp 在 2026/10/10 – 2026/11/08 这 30 天内被下载 28,906 次,日均约 964 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@claude-flow/mcp 还在维护吗?

最新版本 3.1.7 发布于 2026/11/09(今天);至今共发布 14 个版本,其中过去 12 个月发布了 14 个;首次发布于 2026/01/07。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。