Typefully MCP服务器

一个与Typefully API集成的模型上下文协议(MCP)服务器,允许AI助手在Typefully上创建和管理草稿。

  • by pepuscz
  • Python
  • 本地部署
  • 6 星标
  • 更新于
在 GitHub 查看 pepuscz/typefully-mcp-server

使用说明

典型的MCP服务器

一个模型上下文协议(MCP)服务器,提供与Typefully API的集成,使AI助手能够在Typefully上创建和管理草稿。

特点/特性

  • 创建草稿 全力支持:
    • 多条推文串联(使用4个换行符作为分隔符)
    • 自动线程化
    • 安排(具体日期/时间或下一个空闲时段)
    • AutoRT和AutoPlug功能
    • 分享网址
  • 获取已安排的草稿 带有可选过滤功能
  • 获取已发布的草稿 带有可选过滤功能

安装

先决条件

  • Python 3.10 或更高版本
  • 一个具有API访问权限的Typefully账户
  • 您的Typefully API密钥(从Typefully的设置>集成中获取)

从源代码安装

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

配置

API密钥管理

此服务器支持使用macOS密钥链安全存储API密钥。您有两个选项:

选项1:macOS钥匙串(推荐)🔐

在macOS系统钥匙串中安全地存储您的API密钥:

  • 服务: 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服务器提供以下工具:

创建草稿

在Typefully中创建一个新草稿。

参数:

  • content (必填):草稿内容。使用4个连续换行符将内容分成多条推文。
  • threadify (可选):自动将内容拆分为多条推文
  • share (可选):如果为真,返回的有效载荷将包含一个分享链接(share_url)
  • schedule_date (可选):ISO 格式的日期(例如,“2024-01-15T10:30:00Z”)或“next-free-slot”(下一个可用时段)
  • auto_retweet_enabled (可选):为这篇帖子启用AutoRT
  • auto_plug_enabled (可选):为这篇帖子启用自动插入功能

示例:

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

获取已安排的草稿

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

参数:

  • content_filter (可选):过滤草稿,仅包含“推文”或“推文系列”

示例:

Get my scheduled drafts that are threads only

获取已发布的草稿

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

参数:

  • content_filter (可选):过滤草稿,仅包含“推文”或“线程”

示例:

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端点和选项的详细信息,请参阅官方文档。

许可证

麻省理工学院许可证

做出贡献

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