twitterapi-docs-mcp

twitterapi-io-mcp

通过 MCP 为 Claude 和 AI 助手提供离线版 TwitterAPI.io 文档。包含 75 个有效端点（含完整方法、参数和请求体）、32 篇指南、24 篇博客文章。无需 API 密钥。

# Quick install (Claude Code)
claude mcp add twitterapi-io -- npx -y twitterapi-io-mcp

这是什么？

一个 MCP 服务，可让 Claude、Cursor、VS Code Copilot 和其他 AI 助手即时离线访问TwitterAPI.io 文档。

• 75 个有效 API 端点，包含完整的 HTTP 方法、请求体／查询参数、cURL 示例和响应架构
• 32 篇指南，涵盖定价、身份验证、速率限制、webhook 和流式传输
• 24 篇博客文章，包含教程和用例
• 所有 v2 写入端点均有文档说明，包含 login_cookies、proxy 和请求体参数
• 已移除所有弃用的 v1 端点——仅保留当前的 v2 端点
• 无需 API 密钥——所有内容都已打包在本地

与其他代理实时 API 调用（并需要你的 API 密钥）的 Twitter MCP 服务不同，本项目附带完整的文档快照。你的 AI 助手可在本地即时读取文档。

最近更新

• v1.2.0：重写 OpenAPI 优先的抓取器——使用带类型的结构化参数和响应架构，避免 Vercel checkpoint 问题
• v1.1.x：新增 list_timeline 和 get_user_timeline，移除 7 个已弃用的 V1 端点，修复安全问题（hono、ajv、express-rate-limit）
• v1.0.23：平台提示——Twitter 已禁用 since:/until: 搜索运算符。请改用 since_time:UNIX / until_time:UNIX
• v1.0.22：新增 7 个端点（get_space_detail、get_tweet_replies_v2、get_user_about 等）

完整更新历史请参阅 CHANGELOG.md。

免责声明：这是一个独立的社区项目，与 TwitterAPI.io 无关。

安装

之前是否以 twitterapi-docs-mcp 发布？只需更改包名，其他内容保持不变。

要求： Node.js 18.18.0+

Claude Code（推荐）

# Add globally (all projects)
claude mcp add --scope user twitterapi-io -- npx -y twitterapi-io-mcp

# Or project-only
claude mcp add twitterapi-io -- npx -y twitterapi-io-mcp

# Verify
claude mcp list

Claude Desktop

添加到配置文件：

• macOS：~/Library/Application Support/Claude/claude_desktop_config.json
• Windows：%APPDATA%\Claude\claude_desktop_config.json
• Linux：~/.config/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "twitterapi-io": {
      "command": "npx",
      "args": ["-y", "twitterapi-io-mcp"]
    }
  }
}

Cursor

添加到项目根目录下的 .cursor/mcp.json：

{
  "mcpServers": {
    "twitterapi-io": {
      "command": "npx",
      "args": ["-y", "twitterapi-io-mcp"]
    }
  }
}

VS Code / VS Code Insiders

添加到项目根目录下的 .vscode/mcp.json：

{
  "servers": {
    "twitterapi-io": {
      "command": "npx",
      "args": ["-y", "twitterapi-io-mcp"]
    }
  }
}

Windsurf

添加到 ~/.codeium/windsurf/mcp_config.json：

{
  "mcpServers": {
    "twitterapi-io": {
      "command": "npx",
      "args": ["-y", "twitterapi-io-mcp"]
    }
  }
}

Docker

docker run -i --rm $(docker build -q .) 2>/dev/null

或者从源代码构建：

git clone https://github.com/dorukardahan/twitterapi-io-mcp.git
cd twitterapi-io-mcp && npm install
node index.js

可用工具

工具	说明	适用场景
search_twitterapi_docs	对所有文档进行全文搜索（支持模糊匹配和拼写错误）	按关键词查找端点、指南或博客文章
get_twitterapi_endpoint	获取完整的端点文档，包含参数、示例和响应架构	深入了解特定 API 端点
list_twitterapi_endpoints	列出端点，可按类别筛选	浏览某个类别中的可用内容
get_twitterapi_guide	获取指南页面（定价、身份验证、速率限制、webhook 等）	了解平台规则和设置
get_twitterapi_url	按 URL 路径或页面键获取内容	已有文档的直接链接时
get_twitterapi_pricing	快速了解定价	费用相关问题
get_twitterapi_auth	快速了解身份验证	身份验证设置和 API 密钥用法

面向 AI 助手

如果你是使用此 MCP 服务的 AI 助手，以下是快速参考：

用户想要……	使用此工具	示例
查找端点	search_twitterapi_docs	query: "advanced search"
查看端点详情	get_twitterapi_endpoint	endpoint_name: "tweet_advanced_search"
列出所有端点	list_twitterapi_endpoints	category: "user"（可选）
查看定价信息	get_twitterapi_pricing	无需参数
查看身份验证指南	get_twitterapi_auth	无需参数
查看任意指南或页面	get_twitterapi_guide	guide_name: "qps_limits"
按 URL 获取内容	get_twitterapi_url	url: "pricing"

提示：

• 搜索支持模糊匹配和拼写错误容错：输入 "twet object" 仍能找到结果
• 使用 max_results: 5 获取聚焦的结果
• 所有端点均为当前的 v2 版本，不再有已弃用的端点

你可以问什么？

以下是一些适用于此 MCP 服务的实际提示词：

• “TwitterAPI.io 的速率限制是多少？” — 调用 get_twitterapi_guide
• “显示推文高级搜索端点” — 调用 get_twitterapi_endpoint
• “如何通过 API 进行身份验证？” — 调用 get_twitterapi_auth
• “定价是多少？” — 调用 get_twitterapi_pricing
• “列出所有与用户相关的端点” — 调用 list_twitterapi_endpoints，并传入 category: "user"
• “Webhook 过滤规则如何工作？” — 调用 search_twitterapi_docs
• “哪些写入端点需要登录？” — 调用 search_twitterapi_docs，并传入 query: "login_cookies"
• “如何上传媒体并创建推文？” — 依次调用 get_twitterapi_endpoint

按类别列出的全部 75 个端点

类别	数量	端点
用户	13	get_user_by_username, get_user_about, search_user, batch_get_user_by_userids, get_user_last_tweets, get_user_timeline, get_user_mention, get_user_followers, get_user_verified_followers, get_user_followings, check_follow_relationship, get_my_info, get_user_followers_ids
其他	2	get_space_detail, bookmarks_v2
趋势	1	get_trends
推文	10	get_tweet_by_ids, get_article, get_tweet_reply, get_tweet_replies_v2, get_tweet_thread_context, get_tweet_quote, get_tweet_retweeter, tweet_advanced_search, bookmark_tweet_v2, unbookmark_tweet_v2
列表	6	list_timeline, get_list_members, get_list_followers, add_list_member, remove_list_member, get_list_tweets
社群	9	get_all_community_tweets, create_community_v2, delete_community_v2, join_community_v2, leave_community_v2, get_community_by_id, get_community_members, get_community_moderators, get_community_tweets
操作	25	user_login_v2, create_tweet_v2, upload_media_v2, like_tweet_v2, unlike_tweet_v2, delete_tweet_v2, retweet_tweet_v2, follow_user_v2, unfollow_user_v2, update_avatar_v2, update_banner_v2, update_profile_v2, login_by_2fa, login_by_email_or_username, upload_image, create_tweet, like_tweet, retweet_tweet, block_user_v2, mute_user_v2, pin_tweet_v2, unblock_user_v2, unmute_user_v2, unpin_tweet_v2, unretweet_tweet_v2
私信	2	send_dm_v2, get_dm_history
Webhook	4	get_webhook_rules, add_webhook_rule, update_webhook_rule, delete_webhook_rule
流	3	add_user_to_monitor_tweet, remove_user_to_monitor_tweet, get_user_to_monitor_tweet

配置

环境变量	默认值	说明
TWITTERAPI_MCP_DISK_CACHE	1（开启）	设置为 0 可禁用磁盘缓存

故障排除

首次运行时 npx 卡住或失败

首次运行时会从 npm 下载软件包。如果卡住，请尝试：

npx -y twitterapi-io-mcp@latest

或者全局安装：npm install -g twitterapi-io-mcp

“不支持此 Node.js 版本”

此服务需要 Node.js 18.18.0 或更高版本。检查你的版本：

node --version

无法识别 claude mcp add

确保已安装并更新 Claude Code CLI：

claude --version

服务已启动，但没有显示任何工具

添加服务配置后，重启 MCP 客户端。大多数客户端（Claude Desktop、Cursor）都需要重启才能检测到新的 MCP 服务。

工作原理

┌─────────────┐     MCP (stdio)      ┌──────────────────┐
│   Claude /   │ ◄──────────────────► │ twitterapi-io-mcp│
│  Cursor /    │                      │                  │
│  VS Code     │                      │  Bundled docs    │
└─────────────┘                      │  (75 endpoints)  │
                                     └──────────────────┘
                                       No network needed

属性	值
运行时	Node.js 18.18.0+（ES 模块，无需构建步骤）
协议	通过 stdio 使用 MCP
缓存	混合（内存 + 磁盘），TTL 为 24 小时
搜索	使用模糊匹配的 N 元语法标记化

1. AI 助手调用 MCP 工具（搜索、获取端点等）
2. 服务搜索捆绑的文档快照
3. 结果立即返回，无需网络请求

我为何构建它

我每天都会在自己的项目中使用 TwitterAPI.io。在编辑器和他们的文档网站之间来回切换，很快就让人厌烦了。于是我把整套文档打包成了 MCP 服务。现在，我只需询问 Claude，就能在不离开终端的情况下获得答案。

如果你通过 TwitterAPI.io 使用 Twitter/X API，这也能帮你减少上下文切换。安装后就不用操心，直接提问即可。

开发

git clone https://github.com/dorukardahan/twitterapi-io-mcp.git
cd twitterapi-io-mcp
npm install
npm test        # Run tests (48 tests)
npm start       # Start server locally
npm run scrape  # Update docs snapshot from twitterapi.io

不使用 MCP？

如果你的 AI 工具不支持 MCP（例如 OpenClaw），可以改用技能版本——一个包含全部 75 个活跃端点的 Markdown 文件：

👉 twitterapi-io-skill — 兼容 OpenClaw、Claude、GPT、Gemini 和任何大模型。

链接

• npm：twitterapi-io-mcp
• 技能版本：dorukardahan/twitterapi-io-skill
• GitHub：dorukardahan/twitterapi-io-mcp
• MCP 注册表：registry.modelcontextprotocol.io
• TwitterAPI.io：twitterapi.io

贡献

欢迎提交 PR！Fork 此仓库，创建分支，进行修改，然后发起 pull request。请通过 GitHub Issues 提交错误报告和功能请求。

许可证

MIT

致谢

• 感谢 TwitterAPI.io 提供 API 服务
• 感谢 Anthropic 提供 Model Context Protocol
• MCP TypeScript SDK