使用说明

项目简介

mcp-x 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在为大型语言模型 (LLM) 提供与 X (原 Twitter) 平台交互的能力。通过 mcp-x,LLM 可以调用工具发布推文,从而实现更丰富的应用场景。

主要功能点

  • 发布推文 (Post tweets): 允许 LLM 通过调用工具,利用配置的 X API 账户发布新的推文。

安装步骤

  1. 获取代码: 从 GitHub 克隆或下载 mcp-x 仓库代码到本地。

  2. 配置 X API 密钥:

    • 访问 X Developer Platform 并使用您的 X 账户登录。
    • 创建一个应用并获取必要的 API 密钥,包括:
      • API Key
      • API Key Secret
      • Access Token
      • Access Token Secret
      • Bearer token
    • 将这些密钥配置为环境变量。您可以通过多种方式设置环境变量,例如:
      • 在 Claude 配置文件中设置 (推荐): 编辑 Claude 客户端的配置文件 'claude_desktop_config.json' (路径见下方 服务器配置 部分),在 'env' 字段中添加这些密钥。
      • 在运行环境中设置: 直接在您的操作系统或终端环境中设置环境变量。
  3. 安装依赖: 进入项目根目录,执行以下命令同步依赖并更新 lockfile:

    uv sync
  4. 构建项目: 执行以下命令构建项目:

    uv build

    构建产物将位于 'dist/' 目录。

服务器配置

要将 mcp-x 服务器配置到 MCP 客户端 (例如 Claude),您需要在客户端的配置文件中添加 mcp-x 服务器的配置信息。以 Claude 桌面客户端为例,配置文件路径如下:

  • MacOS: '~/Library/Application\ Support/Claude/claude_desktop_config.json'
  • Windows: '%APPDATA%/Claude/claude_desktop_config.json'

在 'claude_desktop_config.json' 文件中的 'mcpServers' 字段下,添加如下配置 (请根据您的实际项目路径进行修改):

{
  "mcpServers": {
    "x": {  // 服务器名称,可以自定义,例如 "x"
      "command": "uv",  // 启动命令,这里使用 uv (基于 Rust 的 pip 和 venv 替代工具,确保已安装)
      "args": [ // 启动参数
        "--directory",
        "PROJECT_PATH/src/mcp_x",  //  **请替换为您的 mcp-x 项目 src/mcp_x 目录的绝对路径**
        "run",
        "mcp-x" //  运行 mcp-x 包的入口点
      ],
      "env": { // 环境变量配置
        "X_API_KEY": "YOUR_API_KEY",  // **请替换为您的 X API Key**
        "X_API_KEY_SECRET": "YOUR_API_KEY_SECRET", // **请替换为您的 X API Key Secret**
        "X_ACCESS_TOKEN": "YOUR_ACCESS_TOKEN", // **请替换为您的 X Access Token**
        "X_ACCESS_TOKEN_SECRET": "YOUR_ACCESS_TOKEN_SECRET", // **请替换为您的 X Access Token Secret**
        "X_BEARER_TOKEN": "YOUR_BEARER_TOKEN", // **请替换为您的 X Bearer Token**
        "LOGGING_PATH": "PROJECT_PATH/src/mcp_x/logs" // **请替换为您的 mcp-x 项目 src/mcp_x 目录下的 logs 目录的绝对路径,用于存放日志文件**
      }
    }
  }
}

请务必将上述配置中的 'PROJECT_PATH' 和 API 密钥替换为您的实际值。

基本使用方法

  1. 启动 MCP 服务器: Claude 客户端在配置 mcp-x 服务器后,会自动尝试启动 mcp-x 服务器。您也可以手动运行 mcp-x 服务器,通过终端进入 'PROJECT_PATH/src/mcp_x' 目录,然后执行命令 'uv run mcp-x'。
  2. 在 LLM 中调用工具: 在支持 MCP 协议的 LLM 应用 (例如 Claude) 中,您可以指示 LLM 使用 'x_PostTweet' 工具来发布推文。例如,您可以向 Claude 发送指令:'请发布一条推文,内容是 "Hello, world! 来自 MCP 服务器 mcp-x"'。
  3. 查看结果: LLM 将调用 mcp-x 服务器的 'x_PostTweet' 工具,并使用您提供的推文内容发布推文。您可以在您的 X (Twitter) 账户上查看发布的推文。

注意: mcp-x 目前仅支持发布推文功能。仓库的 TODO 列表中还计划添加获取推文、删除推文等功能。

信息

分类

通信与社交