Skip to main content

MCP server for Typefully API integration

Project description

MseeP.ai Security Assessment Badge

Typefully MCP Server

A Model Context Protocol (MCP) server that provides integration with the Typefully API, allowing AI assistants to create and manage drafts on Typefully.

Features

  • Create drafts with full support for:
    • Multi-tweet threads (using 4 newlines as separator)
    • Automatic threadification
    • Scheduling (specific date/time or next free slot)
    • AutoRT and AutoPlug features
    • Share URLs
  • Get scheduled drafts with optional filtering
  • Get published drafts with optional filtering

Installation

Prerequisites

  • Python 3.10 or higher
  • A Typefully account with API access
  • Your Typefully API key (get it from Settings > Integrations in Typefully)

Install from source

  1. Clone this repository:
git clone <repository-url>
cd typefully-mcp-server
  1. Create and activate a virtual environment:
python3 -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
  1. Install the package:
pip install -e .

Configuration

API Key Management

This server supports secure API key storage using macOS Keychain. You have two options:

Option 1: macOS Keychain (Recommended) 🔐

Store your API key securely in the macOS System keychain:

  • Service: typefully-mcp-server
  • Account: api_key
  • Password: Your Typefully API key

For detailed keychain setup instructions, see CURSOR_SETUP.md.

Option 2: Environment Variables

You can set the API key as an environment variable or include it directly in your MCP configuration.

Note: Environment variables take priority over keychain storage for compatibility.

MCP Configuration

For detailed MCP client setup instructions (Cursor, Claude Desktop, etc.), see CURSOR_SETUP.md.

Basic MCP configuration example:

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

Usage

Once configured, the MCP server provides the following tools:

create_draft

Create a new draft in Typefully.

Parameters:

  • content (required): The content of the draft. Use 4 consecutive newlines to split into multiple tweets.
  • threadify (optional): Automatically split content into multiple tweets
  • share (optional): If true, returned payload will include a share_url
  • schedule_date (optional): ISO formatted date (e.g., "2024-01-15T10:30:00Z") or "next-free-slot"
  • auto_retweet_enabled (optional): Enable AutoRT for this post
  • auto_plug_enabled (optional): Enable AutoPlug for this post

Example:

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

get_scheduled_drafts

Get recently scheduled drafts from Typefully.

Parameters:

  • content_filter (optional): Filter drafts to only include "tweets" or "threads"

Example:

Get my scheduled drafts that are threads only

get_published_drafts

Get recently published drafts from Typefully.

Parameters:

  • content_filter (optional): Filter drafts to only include "tweets" or "threads"

Example:

Show me all my recently published tweets

Testing

A test script is included to verify the server functionality:

# 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

Development

Project Structure

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

Running Tests

# 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 Reference

This MCP server implements a subset of the Typefully API. For more details on the API endpoints and options, refer to the official documentation.

License

MIT License

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file iflow_mcp_pepuscz_typefully_mcp_server-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: iflow_mcp_pepuscz_typefully_mcp_server-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 9.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.27 {"installer":{"name":"uv","version":"0.9.27","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for iflow_mcp_pepuscz_typefully_mcp_server-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 99de8becb1fe0bd89121577ac6c1d08075f2ba7899a18d524aafccb63840fcb1
MD5 878a0a27b60b0dd6bb20ff779f953752
BLAKE2b-256 22465527c588cfea85c4718157c171acb5105c3c45cc2a223d574eae56a4b78b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page