关键词

X APITwitter API社交媒体LLM工具上下文服务

使用说明

项目简介

x-mcp-server 是一个基于 Model Context Protocol (MCP) 构建的服务器，它充当 LLM 客户端（如 Claude、Cursor AI、Windsurf AI 等）与 X 平台（原 Twitter）之间的桥梁。通过此 MCP 服务器，LLM 客户端可以调用预设的工具来访问 X 平台的功能，例如发布推文、获取用户信息、检索时间线等。

主要功能点

  • 推文管理：支持发布推文、点赞、取消点赞、转发、取消转发、回复、引用推文、发布推文串、添加/删除书签等操作。
  • 用户信息获取：可以获取当前 X 账户的详细信息，以及通过用户 ID 或用户名查询特定用户的详细信息。
  • 用户关系查询：支持获取用户的粉丝列表和关注列表。
  • 社区功能：允许获取社区详情和搜索社区。
  • 时间线检索：能够获取用户的首页时间线、用户时间线以及推文的引用推文列表。

安装步骤

  1. 克隆仓库

    git clone https://github.com/siddheshutd/x-mcp-server
cd x-mcp-server

  2. 安装依赖 确保已安装 Node.js (>=18.0.0) 和 npm (>=8.0.0)。运行以下命令安装项目依赖：

    npm install

  3. 构建项目 运行以下命令编译 TypeScript 代码并生成 JavaScript 文件：

    npm run build

    构建完成后，会在项目根目录下生成 'build' 文件夹，编译后的 'index.js' 文件位于 'build' 文件夹中。

服务器配置

要将 x-mcp-server 配置到 MCP 客户端，您需要提供服务器的启动命令和参数。以下是针对不同 MCP 客户端的配置示例，您需要根据您的实际情况进行调整：

通用配置 (JSON 格式)

{
    "x-mcp-server": {  // 服务器名称，可自定义
        "command": "node", // 启动命令，通常为 node
        "args": [
            "/ABSOLUTE/PATH/TO/PARENT/FOLDER/x-mcp-server/build/index.js" // 参数，指向编译后的 index.js 文件绝对路径
        ],
        "env": {
            "X_API_KEY": "your-x-api-key", // X API 密钥，请替换为您的 X 开发者 API 密钥
            "X_API_KEY_SECRET": "your-x-api-key-secret", // X API 密钥 secret，请替换为您的 X 开发者 API 密钥 secret
            "X_ACCESS_TOKEN": "your-x-access-token", // X 访问令牌，请替换为您的 X 访问令牌
            "X_ACCESS_TOKEN_SECRET": "your-x-access-token-secret" // X 访问令牌 secret，请替换为您的 X 访问令牌 secret
        }
    }
}

配置说明:

  • '"x-mcp-server"': MCP 服务器的名称，可以自定义，用于在客户端中标识该服务器。
  • '"command": "node"': 指定用于启动服务器的命令，这里使用 'node' 执行 JavaScript 文件。
  • '"args": [...]"': 启动命令的参数数组。
    • '"/ABSOLUTE/PATH/TO/PARENT/FOLDER/x-mcp-server/build/index.js"': 请务必替换为 'index.js' 文件的绝对路径。您需要将 '/ABSOLUTE/PATH/TO/PARENT/FOLDER/x-mcp-server' 替换为您的 'x-mcp-server' 项目父文件夹的绝对路径。
  • '"env": {...}': 设置环境变量，用于向服务器传递 X 平台 API 密钥等敏感信息。
    • '"X_API_KEY"', '"X_API_KEY_SECRET"', '"X_ACCESS_TOKEN"', '"X_ACCESS_TOKEN_SECRET"': 请务必替换为您的 X 开发者 API 凭据。您需要在 X 开发者平台 获取这些密钥。

MCP 客户端配置示例:

请参考仓库 README.md 文件中针对 Claude, Cursor AI, Windsurf AI 等客户端的详细配置步骤，将上述 JSON 配置添加到您的 MCP 客户端配置文件中。

基本使用方法

  1. 启动 MCP 服务器 在项目根目录下，运行以下命令启动 x-mcp-server：

    node build/index.js

    服务器成功启动后，您将在控制台看到 'X MCP Server running on stdio' 的提示信息。

  2. 在 MCP 客户端中使用工具 启动您的 MCP 客户端（如 Claude、Cursor AI 等），客户端将自动连接到本地运行的 x-mcp-server。您可以在客户端中通过自然语言指令或特定方式调用 x-mcp-server 提供的工具，例如：

    • 在 Claude 中，您可以提问 "Post a tweet with content 'Hello from MCP server'"，Claude 可能会识别出 'post-tweet' 工具并调用。
    • 在 Cursor AI 或 Windsurf AI 中，您可能需要使用特定的语法或界面来触发工具调用。

    具体的工具调用方式取决于您使用的 MCP 客户端的功能和界面。您可以参考 MCP 客户端的文档或提示来了解如何使用 MCP 服务器提供的工具。

注意:

  • 使用 x-mcp-server 前，请确保您已在 X 开发者平台创建应用并获取了 API 密钥。
  • 请妥善保管您的 X API 密钥和访问令牌，避免泄露。
  • X 平台 API 存在速率限制，请注意控制工具调用频率，避免触发速率限制。

信息

分类

通信与社交

访问项目