Typefully Mcp Server

Typefully Mcp Server

🚀 Typefully MCP 服务器

Typefully MCP 服务器是一个模型上下文协议(MCP)服务器,它集成了 Typefully API,能让 AI 助手在 Typefully 上创建和管理草稿。

🚀 快速开始

Typefully MCP 服务器可使 AI 助手与 Typefully 集成,实现草稿的创建与管理。以下是使用前的准备和配置步骤。

✨ 主要特性

  • 创建草稿,全面支持:
    • 多推文线程(使用 4 个换行符作为分隔符)
    • 自动线程化
    • 定时发布(指定日期/时间或下一个空闲时段)
    • 自动转推(AutoRT)和自动插入(AutoPlug)功能
    • 分享链接
  • 获取已安排的草稿,支持可选过滤
  • 获取已发布的草稿,支持可选过滤

📦 安装指南

前提条件

  • Python 3.10 或更高版本
  • 拥有 API 访问权限的 Typefully 账户
  • 你的 Typefully API 密钥(可在 Typefully 的设置 > 集成中获取)

从源代码安装

  1. 克隆此仓库:
git clone 
cd typefully-mcp-server
  1. 创建并激活虚拟环境:
python3 -m venv venv
source venv/bin/activate  # 在 Windows 上:venv\Scripts\activate
  1. 安装软件包:
pip install -e .

💻 使用示例

基础用法

本服务器提供了创建、获取草稿等功能,以下是具体使用示例。

创建草稿(create_draft)

在 Typefully 中创建一个新草稿。

参数

  • content(必需):草稿的内容。使用 4 个连续的换行符将内容拆分为多条推文。
  • threadify(可选):自动将内容拆分为多条推文
  • share(可选):如果为 true,返回的有效负载将包含一个分享链接
  • schedule_date(可选):ISO 格式的日期(例如,"2024-01-15T10:30:00Z")或 "next-free-slot"
  • auto_retweet_enabled(可选):为该推文启用自动转推功能
  • auto_plug_enabled(可选):为该推文启用自动插入功能

示例

创建一个内容为 "Hello from MCP! This is my first automated tweet." 的草稿,并安排在下一个空闲时段发布

获取已安排的草稿(get_scheduled_drafts)

从 Typefully 获取最近已安排的草稿。

参数

  • content_filter(可选):过滤草稿,仅包含 "tweets" 或 "threads"

示例

获取我所有已安排的推文线程草稿

获取已发布的草稿(get_published_drafts)

从 Typefully 获取最近已发布的草稿。

参数

  • content_filter(可选):过滤草稿,仅包含 "tweets" 或 "threads"

示例

显示我最近发布的所有推文

📚 详细文档

配置说明

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"
}
}
}

测试说明

包含一个测试脚本,用于验证服务器功能:

# 确保你的虚拟环境已激活
source venv/bin/activate  # 在 Windows 上:venv\Scripts\activate

# 测试 API 连接性(需要配置 API 密钥)
python test_read_api.py

开发说明

项目结构

typefully-mcp-server/
├── src/
│   └── typefully_mcp_server/
│       ├── __init__.py
│       ├── server.py      # 主要的 MCP 服务器实现
│       ├── client.py      # Typefully API 客户端
│       ├── keychain.py    # 安全的钥匙串集成
│       └── types.py       # 类型定义
├── pyproject.toml
├── requirements.txt
├── README.md
└── test_read_api.py       # 测试脚本

运行测试

# 确保你的虚拟环境已激活
source venv/bin/activate  # 在 Windows 上:venv\Scripts\activate

# 安装开发依赖项
pip install -e ".[dev]"

# 运行测试
pytest

📄 API 文档

此 MCP 服务器实现了 Typefully API 的一个子集。有关 API 端点和选项的更多详细信息,请参考官方文档。

📄 许可证

本项目采用 MIT 许可证。

贡献说明

欢迎贡献代码!请随时提交拉取请求。

  • 0 关注
  • 0 收藏,7 浏览
  • system 提出于 2025-09-28 07:12

相似服务问题