Automcp

🚀 AutoMCP

AutoMCP is a code generator that automatically generates server and client code for the Model Context Protocol. It creates code automatically based on YAML service definitions.

This is an ongoing project. The repository contains temporary files that will be removed before the final version is packaged as npm, PyPI, etc.

Please refer to MCP Agent to learn how to use this tool in the agent workflow.

✨ Features

• Automatically generate MCP-compatible server code.
• Generate client libraries for easy service consumption.
• Create handler stubs to implement tool functionality.
• Organize code by service, with each service having an independent directory.

🚀 Quick Start

Prerequisites

• Node.js 18 or higher
• npm or yarn

📦 Installation

1. Clone this repository.
2. Install dependencies:

npm install

💻 Usage Examples

Define a Service

Create a YAML file in the services/[service name]/ directory with the following structure:

service:
  name: ServiceName
  version: 1.0.0
  description: Describe your service

tools:
  - name: toolName
    description: Describe the function of the tool
    parameters:
      - name: paramName
        type: string
        description: Parameter description
    returns:
      type: string
      description: Description of the return value

Generate Code

Run the generator script:

./bin/automcp.sh generate

This will perform the following actions:

1. Create server code in generated/[service name]/[service name]_server.ts.
2. Create client code in generated/[service name]/[service name]_client.ts.
3. Create handler stubs in src/custom/[service name]/[tool-name]Handlers.ts.

Implement Handlers

Edit the generated handler files located in src/custom/[service name]/ to implement your tool functionality.

Use the Generated Client

import { ServiceNameClient } from "./generated/service-name/service_name_client.js";

async function main() {
  const client = new ServiceNameClient();

  try {
    await client.connect();

    // Call a tool
    const result = await client.toolName({ paramName: "value" });
    console.log(result);
  } finally {
    await client.disconnect();
  }
}

main().catch(console.error);

📚 Documentation

Check the examples/client_example.ts file for a complete example of using the generated client.

Testing

Use the test script to verify service functionality:

./bin/test-service.sh [service-name]

Temporary Directory Structure (to be improved for packaging)

.
├── bin/                    # Scripts
├── examples/               # Usage examples
├── generated/              # Generated code
│   ├── service-name/       # Service-specific generated code
│   │   ├── service_name_server.ts
│   │   └── service_name_client.ts
├── services/               # Service definitions
│   └── service-name/       # Service name
│       └── service.yaml    # Service YAML file
└── src/
    └── custom/[service name]/ # Custom handlers

Future Plans

• Support more service definition formats (e.g., JSON, XML).
• Add support for client generation in different languages (e.g., Python, Java).
• Implement more complex tool parameter validation and error handling.
• Provide a graphical interface for easy configuration and service management.

📄 License

This project is licensed under the MIT License, which allows for free use, modification, and distribution. Please check the LICENSE file for detailed information.