Eliza Plugin MCP

🚀 MCP Plugin for ElizaOS

The MCP plugin provides integration with the Model Context Protocol (MCP) for ElizaOS, allowing agents to extend their functionality through MCP servers.

🚀 Quick Start

The MCP plugin enables seamless integration with the Model Context Protocol (MCP) in ElizaOS, empowering agents to expand their capabilities via MCP servers.

✨ Features

• Support for multiple MCP servers.
• Flexible configuration options.
• A secure execution environment.
• Integration with the ElizaOS ecosystem.

📦 Installation

Install Dependencies

npm install @elizaos/plugin-mcp

Example Configuration

{
  "name": "Developer Assistant",
  "plugins": ["@elizaos/plugin-mcp"],
  "settings": {
    "mcp": {
      "servers": {
        "github": {
          "command": "npx",
          "args": ["-y", "@modelcontextprotocol/server-github"]
        },
        "puppeteer": {
          "command": "npx",
          "args": ["-y", "@modelcontextprotocol/server-puppeteer"]
        }
      }
    }
  }
}

📚 Documentation

Configuration Options

MCP Server Configuration

Example

{
  "github": {
    "command": "npx",
    "args": ["-y", "@modelcontextprotocol/server-github"],
    "env": {
      "GITHUB_PERSONAL_ACCESS_TOKEN": "<YOUR_TOKEN>"
    }
  },
  "google-maps": {
    "command": "npx",
    "args": ["-y", "@modelcontextprotocol/server-google-maps"],
    "env": {
      "GOOGLE_MAPS_API_KEY": "<YOUR_API_KEY>"
    }
  }
}

Security Precautions

⚠️ Important Note

• Trust Only Known Sources: Ensure all MCP servers are trustworthy to avoid potential security risks.
• Environment Isolation: Use sandboxing to isolate the MCP execution environment in production.

Troubleshooting

1. Check if the MCP service is running properly.
2. Ensure the command paths are correct and available.
3. Check the log files for detailed error information.
4. Confirm that the plugin is loaded correctly.

🤝 Contribution Guidelines

How to Contribute

1. Fork the repository.
2. Create a new branch: git checkout -b feature-branch-name.
3. Commit your changes following the Conventional Commits specification.
4. Push to your repository and submit a Pull Request.

Commit Specification

Use the following types:

• feat: New features.
• fix: Bug fixes.
• chore: Tool or build process changes.
• docs: Documentation updates.
• refactor: Code refactoring.
• style: Formatting adjustments.
• test: Adding tests.

📄 License

This plugin uses the same license as ElizaOS.