Easy MCP

🚀 EasyMCP

EasyMCPは、Minecraftモジュール開発者協定（MCP）サーバーの作成と管理を行うための最新のツールです。このツールは、MCPサーバーの定義と設定プロセスを簡素化し、デコレータAPIとExpressに似たAPIという2つの主要なインターフェースをサポートしています。

🚀 クイックスタート

デコレータ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();

💻 使用例

基本的な使用法

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

高度な使用法

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

@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>)

メソッドをリソースまたはリソーステンプレートとして定義します。URI内でHandlebarsを使用してリソーステンプレートを定義します。

• 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 {
  // ...
}

💡 使用提案

デコレータAPIを使用することで、型を自動的に推論し、ツール、リソース、プロンプト、およびルートの適切な構成を生成できます。これにより、ボイラープレートコードを大幅に削減し、MCPサーバーの定義をより簡潔にすることができます。

📄 ライセンス

このプロジェクトはMITライセンスの下で公開されています。

作者

EasyMCPは Zach Caceres によって作成され、kjlowinの FastMCP からインスピレーションを得ています。