Easy MCP

🚀 EasyMCP

EasyMCP is a modern tool for creating and managing Minecraft Mod Developers' Protocol (MCP) servers. It simplifies the definition and configuration process of MCP servers and supports two main interfaces: Decorator API and Express-like API.

🚀 Quick Start

Define MCP Components Using the Decorator API

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

Define MCP Components Using the Express-like API

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();

💻 Usage Examples

Basic Usage

The above code snippets in the Quick Start section demonstrate the basic usage of both the Decorator API and the Express-like API.

Advanced Usage

The following sections will show more detailed usage of the Decorator API.

📚 Documentation

Decorator API

@Tool(config?: ToolConfig)

Defines a method as a tool. The method can accept any declared parameters, and the type and input configuration are inferred based on TypeScript annotations. An optional context parameter can be added to the last parameter to access MCP features.

• config: An optional tool configuration object.
  • description: An optional description of the tool.
  • optionals: An array of parameter names marked as optional.
  • parameters: An optional array of parameter definitions for full control over the input schema.

Example:

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

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

Defines a method as a resource or a resource template. Use Handlebars to define resource templates in the URI.

• uri: The URI or URI template of the resource.
• config: An optional resource configuration object.
  • name: An optional name of the resource.
  • description: An optional description of the resource.
  • mimeType: An optional MIME type of the resource.

Example:

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

@Prompt(config?: PromptDefinition)

Defines a method as a prompt.

• config: An optional prompt configuration object.
  • name: An optional name of the prompt (defaults to the method name).
  • description: An optional description of the prompt.
  • args: An optional array of parameter definitions.

Example:

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

Defines a class as the root directory of an MCP server. This decorator is used on classes, not methods.

• uri: The URI of the root directory.
• config: An optional configuration object.
  • name: An optional name of the root.

Example:

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

💡 Usage Tip

Using the Decorator API can automatically infer types and generate appropriate configurations for your tools, resources, prompts, and roots, significantly reducing boilerplate code and making MCP server definitions more concise.

🤝 Contribution

Contributions are welcome! Just submit a PR.

📄 License

This project is licensed under the MIT License.

👨‍💻 Author

EasyMCP was created by Zach Caceres, inspired by kjlowin's FastMCP.