Typefully MCP Server

Typefully MCP 服务

一个模型上下文协议（MCP）服务，用于集成 Typefully API，让 AI 助手能够在 Typefully 上创建和管理草稿。

功能

• 创建草稿，全面支持：
  • 多条推文组成的串文（使用 4 个换行符作为分隔符）
  • 自动将内容拆分为串文
  • 定时发布（指定日期/时间或下一个空闲时段）
  • AutoRT 和 AutoPlug 功能
  • 分享 URL
• 获取已安排的草稿，支持可选筛选
• 获取已发布的草稿，支持可选筛选

安装

前提条件

• Python 3.10 或更高版本
• 拥有 API 访问权限的 Typefully 账号
• Typefully API 密钥（在 Typefully 的 Settings > Integrations 中获取）

从源代码安装

1. 克隆此代码库：

git clone <repository-url>
cd typefully-mcp-server

2. 创建并激活虚拟环境：

python3 -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

3. 安装软件包：

pip install -e .

配置

API 密钥管理

此服务支持使用 macOS 钥匙串安全存储 API 密钥。你有两种选择：

选项 1：macOS 钥匙串（推荐）🔐

将 API 密钥安全地存储在 macOS 系统钥匙串中：

• 服务：typefully-mcp-server
• 账户：api_key
• 密码：你的 Typefully API 密钥

有关钥匙串设置的详细说明，请参阅 CURSOR_SETUP.md。

选项 2：环境变量

你可以将 API 密钥设为环境变量，或直接将其写入 MCP 配置。

注意： 为了兼容性，环境变量的优先级高于钥匙串存储。

MCP 配置

有关 MCP 客户端设置的详细说明（Cursor、Claude Desktop 等），请参阅 CURSOR_SETUP.md。

基本 MCP 配置示例：

{
  "mcpServers": {
    "typefully": {
      "command": "/path/to/your/typefully-mcp-server/venv/bin/python",
      "args": ["-m", "typefully_mcp_server.server"],
      "cwd": "/path/to/your/typefully-mcp-server"
    }
  }
}

用法

配置完成后，MCP 服务将提供以下工具：

create_draft

在 Typefully 中创建新草稿。

参数：

• content（必填）：草稿内容。使用连续 4 个换行符将内容拆分为多条推文。
• threadify（可选）：自动将内容拆分为多条推文
• share（可选）：如果为 true，返回的数据中将包含 share_url
• schedule_date（可选）：ISO 格式的日期（例如，“2024-01-15T10:30:00Z”）或“next-free-slot”
• auto_retweet_enabled（可选）：为此帖子启用 AutoRT
• auto_plug_enabled（可选）：为此帖子启用 AutoPlug

示例：

Create a draft with content "Hello from MCP! This is my first automated tweet." and schedule it for next free slot

get_scheduled_drafts

获取 Typefully 最近安排的草稿。

参数：

• content_filter（可选）：筛选草稿，仅包含“tweets”或“threads”

示例：

Get my scheduled drafts that are threads only

get_published_drafts

获取 Typefully 最近发布的草稿。

参数：

• content_filter（可选）：筛选草稿，仅包含“tweets”或“threads”

示例：

Show me all my recently published tweets

测试

此项目包含一个测试脚本，用于验证服务功能：

# Make sure your virtual environment is activated
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Test the API connectivity (requires API key configured)
python test_read_api.py

开发

项目结构

typefully-mcp-server/
├── src/
│   └── typefully_mcp_server/
│       ├── __init__.py
│       ├── server.py      # Main MCP server implementation
│       ├── client.py      # Typefully API client
│       ├── keychain.py    # Secure keychain integration
│       └── types.py       # Type definitions
├── pyproject.toml
├── requirements.txt
├── README.md
└── test_read_api.py       # Test script

运行测试

# Make sure your virtual environment is activated
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install development dependencies
pip install -e ".[dev]"

# Run tests
pytest

API 参考

此 MCP 服务实现了 Typefully API 的部分功能。有关 API 端点和选项的更多详情，请参阅官方文档。

许可证

MIT 许可证

贡献

欢迎贡献！请随时提交 Pull Request。