mcp-server

MCP Server 是一个简单的服务器，它实现了模型上下文协议 (MCP)，以提供一个更简单的 API 来与模型上下文协议交互。

为什么使用这个服务器？

在 "La Rebelion" 中，我们正在开发一套工具和服务，以简化流程和工作流程，从而提供更好、更高效的开发者体验。 这个服务器是这套工具的一部分。

MCP 非常棒，但入门可能会有点令人困惑。 我们创建了一个 外观模式 来简化创建实现模型上下文协议的服务器的过程。 该模式很简单，您只需要使用您自己的逻辑创建 tools，注册这些工具并启动服务器。

创建新服务器的步骤

将来，我们将提供一个 CLI 来创建一个类似于 MCP create server 的新服务器，但目前您可以按照以下步骤，基于创建服务器的官方文档。

mkdir -p my-server/src
cd my-server/
yarn init -y
yarn add @modelcontextprotocol/sdk zod zod-to-json-schema
yarn add -D @types/node typescript
# 魔法就在这里
yarn add @agentico/mcp-server

您需要更新 package.json 文件并创建一个 tsconfig.json 文件。

快速开始

使用您的自定义逻辑实现您的工具，并在 MCPServer 中注册它们。 这是一个简单的 echo 工具的示例：

import { Tool, ToolSchema } from "@agentico/mcp-server";

export class EchoTool extends Tool {
  toolSchema: ToolSchema = { 
    name: "echo",
    description: "回显输入的消息",
    schema: { // 工具所需的参数的 schema
      type: "object",
      properties: {
        message: { type: "string" },
      },
      required: ["message"],
    },
  };

  /**
   * 您的逻辑在这里，实现 execute 方法来定义工具的行为
   * @param input 输入消息 - 使用 schema 来定义输入类型
   * @returns 在示例中，我们正在回显消息
   */
  async execute(input: any): Promise<any> {
    // 这是一个简单的 echo 工具演示，没什么特别的，只是回显消息
    return Promise.resolve({
      content: [
        {
          type: "text",
          text: `${input.message}` 
        }
      ]
      });
  }
}

创建一个包含以下内容的 index.ts 文件：

#!/usr/bin/env node
import { MCPServer } from '@agentico/mcp-server'
import { EchoTool } from "./tools/EchoTool.js";

const myServer = new MCPServer('My MCP Server', '1.0.0');

async function main() {
  // 注册工具
  myServer.registerTool("echo", EchoTool);
  await myServer.run();
}

main().catch((error) => {
  console.error("Server error:", error);
  process.exit(1);
});

就这样！ 您已经创建了一个实现模型上下文协议的简单服务器。 使用 Claude Desktop 或任何其他支持 MCP 的客户端对其进行测试。

使用以下命令构建项目：

yarn build

您可以启动服务器，但它还没有任何逻辑，您可以使用以下命令对其进行测试：

yarn start
# 或
node build/index.js

就这样，开始创建您自己的工具和服务，以简化您的工作流程和流程。

加油，反叛者！ ✊🏻

UML 图

• MCPServer: 注册服务器将使用的工具。
• Tool: 所有工具的基类，包含通用属性和方法。 execute 是调用工具时将调用的方法，在此处实现您的逻辑。
• EchoTool: 工具的特定实现，扩展 Tool 类并定义其自己的 schema 和初始化逻辑。
• EchoSchema: 定义 EchoTool 输入的结构。
• EchoInput: 基于 schema 的输入的类型定义。

这种模式允许使用 MCPServer 和 Tool 类以灵活且可扩展的方式管理和实现工具。

支持我们

如果您觉得这有帮助，请考虑通过给这个存储库一个星标、为项目做出贡献或成为赞助商来支持我们。

您可以在 La Rebelion GitHub Sponsors 上找到有关如何支持我们的更多信息。 此外，请我们喝咖啡, PayPal 是一种支持我们的好方法，或者购买 "La Rebelion" 周边商品。

许可证

该项目根据 MIT 许可证获得许可 - 有关详细信息，请参阅 LICENSE 文件。