Easy MCP

🚀 EasyMCP 中文文檔

EasyMCP 是一款現代化工具，專為 Minecraft 模組開發者協議（MCP）服務器的創建與管理而設計。它極大簡化了 MCP 服務器的定義和配置流程，提供了裝飾器 API 和 Express 類似 API 這兩種主要接口，讓開發者能更高效地進行開發。

🚀 快速開始

💻 基礎用法

使用裝飾器 API 定義 MCP 組件

@Tool({
  description: "Greets a person",
  optionals: ["title"],
})
greet(name: string, title?: string, optionalContext: Context) {
  return `Hello, ${title ? title + " " : ""}${name}!`;
}

使用 Express 類似 API 定義 MCP 組件

import { EasyMCP } from "easy-mcp";

const mcp = new EasyMCP("MyMCP", {
  version: "1.0",
});

mcp.resource({
  uri: "greeting/{name}",
  config: {
    name: "Greeting Resource",
    description: "Generates a greeting message for a given name.",
    mimeType: "text/plain",
  },
});

mcp.prompt({
  name: "introduction",
  description: "Generates an introduction",
  args: [
    { name: "name", type: "string", description: "Your name", required: true },
  ],
  fn: async ({ name }) => {
    return `Hi there! My name is ${name}. It's nice to meet you!`;
  },
});

await mcp.serve();

✨ 主要特性

支持兩種主要接口，即裝飾器 API 和 Express 類似 API，使用裝飾器 API 還可以自動推斷類型併為工具、資源、提示和根生成適當的配置，從而顯著減少樣板代碼，讓 MCP 服務器定義更加簡潔。

📚 詳細文檔

裝飾器 API

@Tool(config?: ToolConfig)

將方法定義為工具。該方法可以接受任意聲明的參數，並根據 TypeScript 註解推斷類型和輸入配置。可以在最後一個參數中添加一個可選的 context 參數以訪問 MCP 功能。

• config：可選的工具配置對象。
  • description：工具的可選描述。
  • optionals：標記為可選的參數名稱數組。
  • parameters：對輸入架構進行全面控制的可選參數定義數組。

示例：

@Tool({
  description: "Generates a greeting message",
  optionals: ["title"],
})
greet(name: string, title?: string) {
  return `Hello, ${title ? `${title} ` : ""}${name}!`;
}

@Resource(uri: string, config?: Partial<ResourceDefinition>)

將方法定義為資源或資源模板。使用 Handlebars 在 URI 中定義資源模板。

• uri：資源的 URI 或 URI 模板。
• config：可選的資源配置對象。
  • name：資源的可選名稱。
  • description：資源的可選描述。
  • mimeType：資源的可選 MIME 類型。

示例：

@Resource("greeting/{name}")
getGreeting(name: string) {
  return `Hello, ${name}!`;
}

@Prompt(config?: PromptDefinition)

將方法定義為提示。

• config：可選的提示配置對象。
  • name：提示的可選名稱（默認為方法名稱）。
  • description：提示的可選描述。
  • args：可選參數定義數組。

示例：

@Prompt({
  description: "Generates a greeting prompt",
  args: [
    { name: "name", description: "Name to greet", required: true },
  ],
})
greetingPrompt(name: string) {
  return `Generate a friendly greeting for ${name}.`;
}

@Root(uri: string, config?: { name?: string })

將類定義為 MCP 服務器的根目錄。此裝飾器用於類，而不是方法。

• uri：根目錄的 URI。
• config：可選配置對象。
  • name：根的可選名稱。

示例：

@Root("/my-sample-dir/photos")
@Root("/my-root-dir", { name: "My laptop's root directory" })
class MyMCP extends EasyMCP {
  // ...
}

🤝 貢獻

歡迎貢獻！只需提交 PR 即可。

📄 許可證

此項目在 MIT 許可證下發行。

👨‍💻 作者

EasyMCP 由 Zach Caceres 創建，靈感來自 kjlowin 的 FastMCP。