README
🚀 MCP 服务器
MCP Server 是一个简单的服务器,实现了模型上下文协议(MCP),为与模型上下文协议交互提供了更简洁的 API。
🚀 快速开始
MCP Server 以简洁的 API 实现了模型上下文协议,让开发者能更高效地与之交互。以下为你展示如何快速搭建一个简单的 MCP 服务器。
基础用法
首先,我们需要实现一个简单的 echo 工具,它会将输入的消息原样返回。
import { Tool, ToolSchema } from "@agentico/mcp-server";
export class EchoTool extends Tool {
toolSchema: ToolSchema = {
name: "echo",
description: "Echoes the input message",
schema: { // 工具所需的参数模式
type: "object",
properties: {
message: { type: "string" },
},
required: ["message"],
},
};
/**
* 在这里实现你的逻辑,定义工具的行为
* @param input 输入消息 - 使用模式定义输入类型
* @returns 示例中,我们只是简单地回显消息
*/
async execute(input: any): Promise<any> {
// 这是一个简单的回显工具演示,没有复杂的功能,只是回显消息
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("服务器错误:", error);
process.exit(1);
});
最后,使用以下命令构建项目:
yarn build
完成上述步骤后,你就创建了一个实现模型上下文协议的简单服务器。可以使用 Claude Desktop 或任何支持 MCP 的其他客户端进行测试。
✨ 主要特性
- 简化使用:MCP 本身功能强大,但对于新手可能较难上手。此服务器通过创建 门面 模式,简化了使用 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
# 这里是 magic
yarn add @agentico/mcp-server
你还需要更新 package.json 文件并创建一个 tsconfig.json 文件。
📚 详细文档
组件说明
MCPServer:用于管理工具和处理传入请求的核心服务器。Tool和ToolSchema:定义如何与外部系统交互的工具接口。main():启动服务器并将所有内容连接在一起的主函数。
🤝 支持
你可以通过多种方式支持我们: 你可以在 La Rebelion GitHub Sponsors 找到更多支持我们的信息,或者通过购买 "La Rebelion" 商品 来支持我们。
📄 许可证
该项目在 MIT License 下许可 - 有关详细信息,请参阅 LICENSE 文件。
微信扫一扫