README
🚀 Mastodon MCP 服务器
Mastodon MCP 服务器是一个基于 Model Context Protocol 的服务器,它提供了与 Mastodon 交互的实用工具。目前,该服务器支持创建带可选媒体附件的帖子,为用户在 Mastodon 平台上的操作提供了便利。
🚀 快速开始
Mastodon MCP 服务器能帮助你轻松在 Mastodon 上创建帖子并管理媒体附件。以下是使用该服务器的基本步骤:
- 完成先决条件的准备,如安装 Node.js 18+、pnpm 工具、1Password CLI 等。
- 按照安装步骤克隆仓库、安装依赖项并构建项目。
- 进行配置,将 Mastodon API 令牌存储在 1Password 中,并可设置 Mastodon 实例 URL。
- 启动 MCP 服务器,使用提供的工具创建帖子。
✨ 主要特性
- 自定义帖子发布:可创建具有自定义可见性和内容警告的帖子,满足不同的社交分享需求。
- 媒体文件管理:支持上传并附加图片、视频、音频等媒体文件,还能为媒体附件添加 alt 文本/描述,增强内容的可访问性。
- 安全凭证管理:使用 1Password CLI 进行安全凭证管理,保障 API 令牌的安全存储和使用。
📦 安装指南
# 克隆仓库
git clone [repository-url]
cd mastodon-mcp
# 安装依赖项
pnpm install
# 构建项目
pnpm build
📚 详细文档
配置说明
该工具需要将 Mastodon API 令牌存储在 1Password 中。将您的令牌存储在:
op://Personal/Floss.Social Key/notesPlain
您可选地通过环境变量设置 Mastodon 实例 URL:
export MASTODON_INSTANCE_URL="https://your.instance.social"
如果未设置,则默认为 https://floss.social。
使用方法
启动 MCP 服务器:
pnpm start
该服务器提供了一个工具 mastodon_create_toot,带有以下参数:
content(必需):帖子的文本内容visibility:"public"、"unlisted"、"private" 或 "direct" 中的一个(默认:"public")sensitive:标记敏感内容的布尔标志(默认:false)spoiler_text:显示在内容前的文字警告(默认:"")media_file:要附加的媒体文件路径media_description:附件媒体的 alt 文本/描述
使用 MCP 检查器的示例用法
- 启动检查器:
npx @modelcontextprotocol/inspector node dist/mcp-server.js
- 打开 http://localhost:5173 在您的浏览器中
- 使用类似以下参数的工具:
{
"content": "来自 MCP 的问候!",
"visibility": "public",
"media_file": "/path/to/image.jpg",
"media_description": "美丽的日落"
}
开发相关
# 以开发模式运行,带有自动重新加载
pnpm dev
# 构建项目
pnpm build
# 运行构建后的服务器
pnpm start
安全保障
- 代码库中没有硬编码凭证。
- API 令牌安全地存储并从 1Password 中检索。
- API 响应被 git 忽略以防止意外凭证泄露。
📄 许可证
本项目采用 ISC 许可证。
Scan to contact