elizaos MCP

alt text

ElizaOS连接器协会MCP

Society ElizaOS连接器MCP（模型上下文协议）允许您将ElizaOS代理与Cursor无缝集成。这使您能够在Cursor IDE中列出可用代理，选择要与之交互的特定代理，并直接与ElizaOS代理聊天。

此MCP服务器在您的计算机上本地运行，由Cursor使用 stdio 传输，这意味着游标会自动启动并与之通信。

特性

• 列出代理：从您的ElizaOS实例中检索可用代理的列表。
• 选择代理：选择一个特定的代理进行交互。这 Room ID 将自动设置为匹配 Agent ID.
• 与客服聊天：向选定的ElizaOS代理发送消息并接收响应。
• 检查状态：验证MCP服务器的连接状态和当前代理配置。

先决条件

• Node.js和npm（v14或更高版本）。
• ElizaOS服务器实例正在运行并可访问（例如，在本地 http://localhost:3000).
• 支持MCP的游标IDE。

使用游标安装和使用

快速设置（推荐）

使用此MCP的最简单方法是直接使用npx与Cursor配合使用。Cursor将自动处理包的运行。

1. 配置光标:

创建或打开 .cursor/mcp.json 项目文件夹（或全局文件夹）中的文件 ~/.cursor/mcp.json 文件）并添加：

{
  "mcpServers": {
    "society-elizaos-mcp-npx": { 
      "command": "npx",
      "args": [
        "-y",
        "society-elizaos-mcp@1.0.9"
      ],
      "env": {
        "ELIZAOS_SERVER_URL": "http://localhost:3000",
        "ELIZAOS_USER_ID": "000000000000000000000000000000000000",  example ad64a76a-0e09-0899-b8f8-492d6aea4118
        "ELIZAOS_WORLD_ID": "000000000000000000000000000000000000", example c930b151-dcfb-41c5-96af-550ffea7023c
        "ELIZAOS_AGENT_ID": "000000000000000000000000000000000000", example 85e9fa66-6f8c-0f18-922c-d6c962e21e18
        "ELIZAOS_ROOM_ID": "000000000000000000000000000000000000",  Need to be equal to the ELIZAOS_AGENT_ID 
        "ELIZAOS_CONNECTION_TIMEOUT": "120000",
        "ELIZAOS_RESPONSE_TIMEOUT": "90000",
        "PORT": "3099",
        "DEBUG": "true",
        "NODE_ENV": "production",
        "MCP_DISABLE_PINGS": "true"
      }
  }
}

1. 替换所有占位符UUID 使用您的实际ElizaOS ID。

1. 重新启动游标 以应用配置更改。

1. 开始使用工具 在光标界面中，它们将显示为：

- get_status - list_agents - chat_with_agent - set_agent

地方发展设置

如果要运行连接器的本地开发版本，请执行以下步骤：

1. 克隆并安装依赖项:

   git clone https://github.com/your-username/society-elizaos-mcp.git
   cd society-elizaos-mcp
   npm install

1. 构建包:

   npm run build

1. 在本地运行:

   # Set required environment variables
   export ELIZAOS_SERVER_URL="http://localhost:3000"
   export ELIZAOS_USER_ID="your-elizaos-user-uuid"
   export ELIZAOS_WORLD_ID="your-elizaos-world-uuid"
   export ELIZAOS_AGENT_ID="your-initial-agent-uuid"
   export ELIZAOS_ROOM_ID="your-initial-agent-uuid"

   # Run the server
   node dist/index.js

1. 或者使用便利脚本:

   # The script sets default environment variables and runs the server
   ./scripts/mcp_run.sh

1. 为本地版本配置游标:

如果你想让Cursor使用本地版本而不是npm包，请更新你的 .cursor/mcp.json:

   {
     "mcpServers": {
       "society-elizaos-mcp-local": {
         "command": "node",
         "args": [
           "/path/to/your/society-elizaos-mcp/dist/index.js"
         ],
         "env": {
           "ELIZAOS_SERVER_URL": "http://localhost:3000",
           "ELIZAOS_USER_ID": "your-elizaos-user-uuid",
           "ELIZAOS_WORLD_ID": "your-elizaos-world-uuid",
           "ELIZAOS_AGENT_ID": "your-initial-agent-uuid", 
           "ELIZAOS_ROOM_ID": "your-initial-agent-uuid",
           "ELIZAOS_CONNECTION_TIMEOUT": "120000",
           "ELIZAOS_RESPONSE_TIMEOUT": "90000",
           "PORT": "3069",
           "DEBUG": "true",
           "NODE_ENV": "production",
           "MCP_DISABLE_PINGS": "true"
         }
       }
     }
   }

配置选项

所有配置都是通过环境变量完成的，您可以在 env 你的部分 .cursor/mcp.json 文件：

安全通知

⚠️ 重要：永远不要在您的 .cursor/mcp.json 文件或您发布的任何代码中。MCP不需要任何外部API密钥即可运行。

MCP工具参考

配置后，Cursor可以通过以下四个工具与ElizaOS代理通信：

1. get_status

获取ElizaOS MCP的当前连接状态和配置。

参数：无需（传递一个空对象 {} 或 {"random_string": "any"})

退货:

{
  "connectionState": "connected", 
  "currentAgent": "agent-uuid",
  "currentRoom": "room-uuid",
  "serverUrl": "http://localhost:3000",
  "userId": "user-uuid",
  "worldId": "world-uuid",
  "connectionTimeout": 120000,
  "responseTimeout": 90000
}

2. list_agents

列出ElizaOS服务器上的所有可用代理。

参数：无需（传递一个空对象 {} 或 {"random_string": "any"})

退货:

[
  {
    "id": "agent-uuid-1",
    "name": "Agent Name 1"
  },
  {
    "id": "agent-uuid-2",
    "name": "Agent Name 2"
  }
]

3. chat_with_agent

向当前选定的代理发送消息并返回响应。

参数:

{
  "message": "Your message to the agent goes here"
}

退货:

{
  "messageText": "Your message to the agent goes here",
  "senderId": "your-user-id",
  "response": {
    "senderId": "agent-id",
    "senderName": "Agent Name",
    "text": "The agent's response text",
    "roomId": "room-id",
    "createdAt": 1747632281772,
    "source": "mcp_client_chat",
    "thought": "Optional agent thought process if available",
    "actions": ["REPLY"]
  }
}

4. set_agent

切换到其他代理。请注意 agent_id 和 room_id ElizaOS中的内容必须相同。

参数:

{
  "agent_id": "the-agent-uuid-to-use",
  "room_id": "the-agent-uuid-to-use"
}

退货:

{
  "success": true,
  "oldConfig": {
    "agentId": "previous-agent-uuid",
    "roomId": "previous-room-uuid"
  },
  "newConfig": {
    "agentId": "new-agent-uuid",
    "roomId": "new-agent-uuid"
  }
}

故障排除

常见问题

• “缺少必需的ElizaOS环境变量”:

- 确保 ELIZAOS_USER_ID, ELIZAOS_WORLD_ID，以及 ELIZAOS_SERVER_URL 在MCP配置中设置。

• “无法连接到ElizaOS聊天”:

- 确认您的ElizaOS服务器正在指定的URL上运行。 - 验证代理和房间ID是否匹配且有效。

• 无代理响应:

- 检查代理在ElizaOS环境中是否处于活动状态。 - 增加 ELIZAOS_RESPONSE_TIMEOUT 如果你的代理人需要更长的时间来回复。

• 对于ElizaOS，agent_id和room_id必须相同:

- 使用时 set_agent，确保两个ID的值相同。

许可证

麻省理工学院

______________________________________________________________________

本自述提供了设置和使用带有Cursor的Society ElizaOS连接器MCP的全面指南。如需更多帮助，请在GitHub存储库上打开问题。