MCP Plugin for ElizaOS

ElizaOS 的 MCP 插件

此插件将模型上下文协议（MCP）集成到 ElizaOS 中，使 Agent 能够连接多个 MCP 服务并使用它们的资源、提示词和工具。

🔍 什么是 MCP？

模型上下文协议（MCP）是一种开放协议，可实现大模型应用与外部数据源和工具之间的无缝集成。它提供了一种将大模型与其所需上下文连接起来的标准化方式。

此插件允许 ElizaOS Agent 同时访问多个 MCP 服务，每个服务都提供不同的功能：

• 资源：供 Agent 参考的上下文和数据
• 提示词：模板化消息和工作流
• 工具：供 Agent 执行的函数

📦 安装

在 ElizaOS 项目中安装此插件：

• npm

npm install @fleek-platform/eliza-plugin-mcp

• pnpm

pnpm install @fleek-platform/eliza-plugin-mcp

• yarn

yarn add @fleek-platform/eliza-plugin-mcp

• bun

bun add @fleek-platform/eliza-plugin-mcp

🚀 用法

1. 将插件添加到角色配置中：

{
  "name": "Your Character",
  "plugins": ["@fleek-platform/eliza-plugin-mcp"],
  "settings": {
    "mcp": {
      "servers": {
        "github": {
          "type": "stdio",
          "name": "Code Server",
          "command": "npx",
          "args": ["-y", "@modelcontextprotocol/server-github"]
        }
      }
    }
  }
}

⚙️ 配置选项

MCP 支持两种类型的服务：“stdio”和“sse”。每种类型都有自己的配置选项。

通用选项

选项	类型	说明
type	string	MCP 服务的类型：“stdio”或“sse”
name	string	服务的显示名称
timeout	number	工具调用的超时时间（秒）（默认值：60）
disabled	boolean	是否禁用此服务

stdio 服务选项

选项	类型	说明
command	string	运行 MCP 服务的命令
args	string[]	服务的命令行参数
env	object	传递给服务的环境变量
cwd	string	可选 服务运行时所在的工作目录

sse 服务选项

选项	类型	说明
url	string	SSE 端点的 URL

🛠️ 使用 MCP 功能

配置完成后，插件会自动向 Agent 提供 MCP 服务的功能：

上下文提供器

插件包含三个提供器，可将 MCP 功能添加到 Agent 的上下文中：

1. MCP_SERVERS：列出可用服务及其工具、资源和提示词

🔄 插件流程

下图展示了 MCP 插件在工具选择和执行过程中的流程：

graph TD
    %% Starting point - User request
    start[User Request] --> action[CALL_TOOL Action]

    %% MCP Server Validation
    action --> check{MCP Servers Available?}
    check -->|No| fail[Return No Tools Available]
    
    %% Tool Selection Flow
    check -->|Yes| state[Get MCP Provider Data]
    state --> prompt[Create Tool Selection Prompt]
    
    %% First Model Use - Tool Selection
    prompt --> model1[Use Language Model for Tool Selection]
    model1 --> parse[Parse Selection]
    parse --> retry{Valid Selection?}
    
    %% Second Model Use - Retry Selection
    retry -->|No| feedback[Generate Feedback]
    feedback --> model2[Use Language Model for Retry]
    model2 --> parse
    
    %% Tool Selection Result
    retry -->|Yes| toolAvailable{Tool Available?}
    toolAvailable -->|No| fallback[Fallback Response]
    
    %% Tool Execution Flow
    toolAvailable -->|Yes| callTool[Call MCP Tool]
    callTool --> processResult[Process Tool Result]
    
    %% Memory Creation
    processResult --> createMemory[Create Memory Record]
    createMemory --> reasoningPrompt[Create Reasoning Prompt]
    
    %% Third Model Use - Response Generation
    reasoningPrompt --> model3[Use Language Model for Response]
    model3 --> respondToUser[Send Response to User]
    
    %% Styling
    classDef model fill:#f9f,stroke:#333,stroke-width:2px;
    classDef decision fill:#bbf,stroke:#333,stroke-width:2px;
    classDef output fill:#bfb,stroke:#333,stroke-width:2px;
    
    class model1,model2,model3 model;
    class check,retry,toolAvailable decision;
    class respondToUser,fallback output;

📋 示例：设置多个 MCP 服务

以下是一个包含两种类型多个 MCP 服务的完整配置示例：

{
  "name": "Developer Assistant",
  "plugins": ["@elizaos/plugin-mcp", "other-plugins"],
  "settings": {
    "mcp": {
      "servers": {
        "github": {
          "command": "npx",
          "args": ["-y", "@modelcontextprotocol/server-github"],
          "env": {
            "GITHUB_PERSONAL_ACCESS_TOKEN": "<YOUR_TOKEN>"
          }
        },
        "puppeteer": {
          "command": "npx",
          "args": ["-y", "@modelcontextprotocol/server-puppeteer"]
        },
        "google-maps": {
          "command": "npx",
          "args": ["-y", "@modelcontextprotocol/server-google-maps"],
          "env": {
            "GOOGLE_MAPS_API_KEY": "<YOUR_API_KEY>"
          }
        }
      },
      "maxRetries": 2
    }
  }
}

🔒 安全注意事项

请注意，MCP 服务可以执行任意代码，因此请仅连接到可信的服务。

🔍 故障排除

如果 MCP 插件出现问题：

1. 检查 MCP 服务是否已正确配置并运行
2. 确保 ElizaOS 环境可以访问这些命令
3. 查看日志，排查连接错误
4. 确认插件已在角色配置中正确加载

👥 参与贡献

感谢您考虑为我们的项目做出贡献！

如何贡献

1. Fork 此代码仓库。
2. 创建新分支：git checkout -b feature-branch-name。
3. 进行修改。
4. 使用 Conventional Commits 规范提交更改。
5. 推送到您的 Fork，并提交拉取请求。

提交规范

我们的提交消息遵循 Conventional Commits：

• test：💍 补充缺失的测试
• feat：🎸 新功能
• fix：🐛 修复 Bug
• chore：🤖 构建流程或辅助工具变更
• docs：✏️ 仅修改文档
• refactor：💡 既不修复 Bug 也不添加功能的代码变更
• style：💄 标记、空白字符、格式、缺少分号等变更

📄 许可证

此插件采用与 ElizaOS 相同的许可证发布。