使用说明

项目简介

本项目 'x-v2-server' 是一个 MCP (Model Context Protocol) 服务器的实现,它为 AI 助手提供了连接和操作 Twitter/X (原 Twitter) API V2 的一系列工具。通过这个服务器,AI 助手可以安全、可扩展地访问 Twitter/X 的数据和功能,例如获取用户推文、搜索推文、发布推文、管理列表等。这使得 AI 应用能够更深入地集成 Twitter/X 的社交网络信息,实现更丰富的应用场景。

主要功能点

  • 推文检索:
    • 按用户ID检索推文
    • 按推文ID检索单个推文
    • 检索提及用户的推文
    • 搜索推文
    • 获取趋势话题
  • 推文互动:
    • 发布推文 (支持文本和图片)
    • 回复推文
    • 引用推文
    • 点赞推文
  • 用户管理:
    • 关注用户
    • 取消关注用户
    • 按用户名获取用户信息
  • 列表管理:
    • 创建列表
    • 添加列表成员
    • 移除列表成员
    • 获取用户拥有的列表

所有工具均通过 MCP 协议以标准化的 JSON-RPC 接口提供,方便 LLM 客户端调用。

安装步骤

  1. 安装 Node.js 和 npm: 确保你的开发环境中已安装 Node.js 和 npm (Node 包管理器)。
  2. 克隆仓库: 将 'x-v2-server' 仓库克隆到本地:
    git clone https://github.com/NexusX-MCP/x-v2-server.git
    cd x-v2-server
  3. 安装依赖: 在仓库根目录下运行以下命令安装项目依赖:
    npm install
  4. 构建项目: 运行构建命令编译 TypeScript 代码:
    npm run build

服务器配置

MCP 客户端需要配置以下信息以连接到 'x-v2-server' 服务器。配置信息为 JSON 格式,通常在 MCP 客户端的服务器配置中进行设置。

{
  "serverName": "x-v2-server",
  "command": "node",
  "args": [
    "dist/index.js"
  ],
  "env": {
    "TWITTER_API_KEY": "<你的 Twitter API Key>",
    "TWITTER_API_KEY_SECRET": "<你的 Twitter API Secret Key>",
    "TWITTER_ACCESS_TOKEN": "<你的 Twitter Access Token>",
    "TWITTER_ACCESS_TOKEN_SECRET": "<你的 Twitter Access Token Secret>"
  }
}

配置参数说明:

  • 'serverName': 服务器名称,设置为 'x-v2-server'。
  • 'command': 运行服务器的命令,这里使用 'node'。
  • 'args': 命令参数,指向编译后的服务器入口文件 'dist/index.js'。
  • 'env': 环境变量配置,用于 Twitter API 认证:

重要: 请务必替换 '<你的 Twitter API Key>' 等占位符为你实际的 Twitter API 凭据。

基本使用方法

  1. 启动服务器: 在仓库根目录下,使用 MCP 客户端配置中提供的命令启动服务器。例如,如果使用 '@modelcontextprotocol/inspector' 工具,可以运行:

    npx @modelcontextprotocol/inspector node dist/index.js

    然后通过浏览器访问 'http://127.0.0.1:6274',配置环境变量并与工具进行交互。

  2. 通过 MCP 客户端调用工具: 服务器启动后,MCP 客户端可以向服务器发送 JSON-RPC 请求来调用各种 Twitter/X API 工具。具体的工具名称和参数请参考 'README.md' 文件中 "Tools" 部分的描述,或者查看 'src/index.ts' 中 'capabilities.tools' 的定义。

例如,要使用 'get_tweets_by_userid' 工具获取用户 ID 为 '2244994945' 的推文,客户端需要构造符合 MCP 协议的 JSON-RPC 请求,指定工具名称为 'get_tweets_by_userid',参数为 '{ "userId": "2244994945" }'。服务器会处理请求,调用 Twitter API,并将结果以 JSON-RPC 响应返回给客户端。

详细的 MCP 协议和 JSON-RPC 请求格式请参考 Model Context Protocol 官方文档

信息

分类

通信与社交