README
🚀 X.com MCP服务器
这是一个模型上下文协议(MCP)服务器,可提供对X.com API功能的访问。该服务器允许大语言模型(LLMs)通过OAuth 2.0认证与X.com(原Twitter)进行交互,支持所有主要的帖子相关操作,包括读取、撰写、搜索和管理帖子、点赞、转发和收藏等。
🚀 快速开始
X.com MCP服务器提供了便捷的方式让LLMs与X.com进行交互。你可以按照以下步骤快速开始使用:
- 完成安装(具体安装方式见“📦 安装指南”)。
- 进行配置,包括设置环境变量和完成认证(具体配置方法见“📚 详细文档”)。
- 参考“💻 使用示例”中的示例交互,发起请求与X.com进行交互。
✨ 主要特性
- OAuth 2.0认证 - 安全的Bearer令牌认证方式。
- 完整的帖子API覆盖 - 涵盖X.com官方API中所有帖子相关的端点。
- 类型安全 - 完全使用TypeScript实现,并结合Zod进行验证。
- 全面的工具集 - 提供21个工具,涵盖X.com的所有主要操作。
📦 安装指南
使用pnpm(推荐)
pnpm install
pnpm run build
安装完成后,你可以使用以下命令运行服务器:
node dist/index.js
使用Docker
docker build -t x.com-mcp .
docker run -i --rm -e X_COM_ACCESS_TOKEN=your-access-token x.com-mcp
💻 使用示例
基础用法
1. 创建帖子
{
"name": "createPost",
"arguments": {
"text": "Hello world! This is my first post via the MCP server.",
"reply_settings": "everyone"
}
}
2. 搜索近期帖子
{
"name": "searchRecent",
"arguments": {
"query": "artificial intelligence",
"max_results": 10,
"tweet.fields": "created_at,author_id,public_metrics"
}
}
3. 获取用户时间线
{
"name": "getUserTimeline",
"arguments": {
"id": "123456789",
"max_results": 20,
"expansions": "author_id"
}
}
4. 点赞帖子
{
"name": "likePost",
"arguments": {
"user_id": "123456789",
"tweet_id": "987654321"
}
}
5. 获取帖子数量统计
{
"name": "getPostCountsRecent",
"arguments": {
"query": "machine learning",
"granularity": "day"
}
}
📚 详细文档
可用工具
查找
getSinglePost- 根据ID检索单个帖子,可选择扩展字段。getBulkPosts- 根据ID批量检索最多100个帖子。
管理帖子
createPost- 创建包含文本、媒体、投票、回复等内容的新帖子。deletePost- 根据ID删除帖子。hideReply- 隐藏或显示帖子的回复。
时间线
getUserTimeline- 获取用户的帖子时间线。getUserMentions- 获取提及特定用户的帖子。
搜索
searchRecent- 搜索近期帖子(过去7天)。searchAll- 搜索所有帖子(完整存档 - 需要学术/企业访问权限)。
帖子数量统计
getPostCountsRecent- 获取近期帖子按时间桶划分的数量统计。getPostCountsAll- 获取所有帖子按时间桶划分的数量统计(学术/企业)。
转发
getRetweets- 获取转发特定帖子的帖子。createRetweet- 转发帖子。deleteRetweet- 取消转发。
点赞
getLikingUsers- 获取点赞特定帖子的用户。getLikedTweets- 获取用户点赞的帖子。likePost- 点赞帖子。unlikePost- 取消点赞帖子。
收藏
getUserBookmarks- 获取用户收藏的帖子。bookmarkPost- 收藏帖子。removeBookmark- 取消收藏。
配置
环境变量
X_COM_ACCESS_TOKEN(必需):你的X.com OAuth 2.0访问令牌。
认证设置
- 在 developer.x.com 创建X.com开发者账户。
- 创建新的项目和应用。
- 生成OAuth 2.0凭证。
- 实现OAuth 2.0授权码与PKCE流程。
- 将生成的访问令牌存储为
X_COM_ACCESS_TOKEN。
为Claude.app配置
添加到你的Claude设置中:
使用pnpm
"mcpServers": {
"x-com": {
"command": "node",
"args": ["dist/index.js"],
"env": {
"X_COM_ACCESS_TOKEN": "your-access-token"
}
}
}
使用Docker
"mcpServers": {
"x-com": {
"command": "docker",
"args": ["run", "-i", "--rm", "-e", "X_COM_ACCESS_TOKEN=your-access-token", "x.com-mcp"]
}
}
API端点覆盖范围
此服务器实现了X.com API v2规范中所有与帖子相关的端点:
- 查找:
/2/tweets/:id,/2/tweets - 管理帖子:
/2/tweets(POST),/2/tweets/:id(DELETE),/2/tweets/:id/hidden(PUT) - 时间线:
/2/users/:id/tweets,/2/users/:id/mentions - 搜索:
/2/tweets/search/recent,/2/tweets/search/all - 帖子数量统计:
/2/tweets/counts/recent,/2/tweets/counts/all - 转发:
/2/tweets/:id/retweets,/2/users/:id/retweets - 点赞:
/2/tweets/:id/liking_users,/2/users/:id/liked_tweets,/2/users/:id/likes - 收藏:
/2/users/:id/bookmarks
所需权限范围
确保你的X.com应用具有以下OAuth 2.0权限范围:
tweet.read- 读取帖子和用户信息。tweet.write- 创建和删除帖子。tweet.moderate.write- 隐藏/显示回复。users.read- 读取用户信息。like.read- 读取点赞信息。like.write- 点赞和取消点赞帖子。bookmark.read- 读取收藏信息。bookmark.write- 创建和删除收藏。
调试
你可以使用MCP检查器来调试服务器:
npx @modelcontextprotocol/inspector node dist/index.js
向Claude提问的示例
- “你能搜索近期关于人工智能的帖子吗?”
- “创建一篇关于TypeScript优点的帖子。”
- “查找提及机器学习的帖子并显示其参与度指标。”
- “获取我近期的收藏并分析主题。”
构建
# 安装依赖
pnpm install
# 构建TypeScript
pnpm run build
# 启动服务器
pnpm start
速率限制
请注意X.com API的速率限制:
- 大多数读取操作:每15分钟300个请求。
- 写入操作:每15分钟50个请求。
- 收藏操作:每15分钟50次写入 / 180次读取。
详细的速率限制信息请参考 X.com API文档。
Scan to contact