Eliza Plugin MCP

🚀 MCP 插件用于 ElizaOS

MCP 插件为 ElizaOS 提供了与 Model Context Protocol (MCP) 的集成能力，借助此插件，代理能够通过 MCP 服务器扩展自身功能，为系统带来更丰富的应用场景和更强的实用性。

🚀 快速开始

MCP 插件为 ElizaOS 集成了 Model Context Protocol (MCP)，让代理可通过 MCP 服务器拓展功能。以下是快速开始使用该插件的相关内容。

✨ 主要特性

• 🔀 支持多种 MCP 服务器，满足不同场景需求。
• ⚙️ 具备灵活的配置选项，方便用户根据实际情况调整。
• 🔒 拥有安全的执行环境，保障系统运行安全。
• 🌐 能够整合 ElizaOS 生态系统，实现更好的协同工作。

📦 安装指南

依赖安装

执行以下命令安装依赖：

npm install @elizaos/plugin-mcp

示例配置

以下是示例配置代码：

{
  "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"]
        }
      }
    }
  }
}

📚 详细文档

配置选项

MCP 服务器配置

示例

{
  "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>"
    }
  }
}

安全注意事项

⚠️ 重要提示

• 仅信任来源：确保所有 MCP 服务器都是可信赖的，避免潜在的安全风险。
• 环境隔离：在生产环境中使用 sandbox 隔离 MCP 执行环境。

故障排除

1. 检查 MCP 服务是否正常运行。
2. 确保命令路径正确且可用。
3. 查看日志文件获取详细错误信息。
4. 确认插件已正确加载。

贡献指南

如何贡献

1. Fork 仓库。
2. 创建新分支：git checkout -b feature-branch-name。
3. 提交更改并遵循 Conventional Commits 规范。
4. 推送至自己的仓库并提交 Pull Request。

提交规范

使用以下类型：

• feat：新功能。
• fix：修复问题。
• chore：工具或构建流程变更。
• docs：文档更新。
• refactor：代码重构。
• style：格式化调整。
• test：添加测试。

📄 许可证

该插件采用与 ElizaOS 相同的许可。