La Rebelion MCP Server

🚀 MCP Server

The MCP Server is a straightforward server that implements the Model Context Protocol (MCP), offering a simpler API for interacting with the Model Context Protocol.

🚀 Quick Start

Why Use This Server?

At "La Rebelion", we're developing a series of tools and services to streamline processes and workflows, thereby enhancing the developer experience. This server is part of our toolset.

MCP is extremely powerful but can be a bit complex for beginners. We've created a Facade to simplify the process of creating a server that implements MCP. The pattern is simple: you just need to create tools with your own logic, register the tools, and start the server.

Steps to Create a New Server

In the future, we'll provide a CLI to create a new server, similar to MCP create server. For now, you can follow the steps in the official documentation:

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
# This is where the magic happens
yarn add @la-rebelion/mcp-server

You need to update the package.json file and create a tsconfig.json file.

Getting Started

Implement tools with your own logic and register them in the MCPServer. Here's an example of a simple echo tool:

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

export class EchoTool extends Tool {
  toolSchema: ToolSchema = { 
    name: "echo",
    description: "Echoes the input message",
    schema: { // The parameter pattern required by the tool
      type: "object",
      properties: {
        message: { type: "string" },
      },
      required: ["message"],
    },
  };

  /**
   * Implement your logic here to define the behavior of the tool
   * @param input The input message - use the pattern to define the input type
   * @returns In the example, we simply echo the message
   */
  async execute(input: any): Promise<any> {
    // This is a simple demonstration of an echo tool, nothing special, just echoing the message
    return { message: input.message };
  }
}

Import and register this tool in your server code:

import express from "express";
import { MCP_server } from "@la-rebelion/mcp-server";

const app = express();
app.use("/", new MCP_server([EchoTool]).routes());
app.listen(3000, () => {
  console.log("Server is running on http://localhost:3000");
});

💻 Usage Examples

Basic Usage

import { Tool, ToolSchema } from "@la-rebelion/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 { message: input.message };
  }
}

Advanced Usage

import express from "express";
import { MCP_server } from "@la-rebelion/mcp-server";

const app = express();
app.use("/", new MCP_server([EchoTool]).routes());
app.listen(3000, () => {
  console.log("Server is running on http://localhost:3000");
});

📚 Documentation

UML Diagram

Here's a brief UML representation of the system:

+-------------------+
|                   |
|     MCP_server    |
|                   |
+-------------------+
          ^
          |
+-------------------+
|                   |
|      EchoTool     |
|                   |
+-------------------+

🤝 Support Us

Support us by purchasing our GitHub Sponsorship, buying us a coffee, using PayPal, or purchasing merchandise from "[La Rebelion]".

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.