Buttondown

ModelContextProtocal server for interacting with buttondown

typescript

0

GitHub Stars

typescript

Language

7 months ago

First Indexed

3 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "the-focus-ai-buttondown-mcp": {
      "command": "pnpm",
      "args": [
        "mcp:start"
      ],
      "env": {
        "BUTTONDOWN_API_KEY": "YOUR_API_KEY"
      }
    }
  }
}

You run the Buttondown API integration MCP server to manage newsletters, drafts, analytics, and scheduling through an MCP client. It provides a dedicated server you can interact with from AI agents or automation workflows, enabling programmatic control over emails and insights while keeping credentials secure.

How to use

Start by running the MCP server locally, then connect your MCP client to manage emails, drafts, analytics, and scheduling. Use the available stdio commands to start the server and the built-in MCP tools to perform common tasks.

You can perform core actions such as listing emails, creating drafts, scheduling sends, and retrieving analytics. Your MCP client can call these tools to orchestrate campaigns, monitor performance, and automate workflows without manually interacting with a UI.

How to install

# Install dependencies (example, using pnpm as the recommended workflow)
pnpm install

# Start the MCP server in development mode
pnpm mcp:start

# (Optional) Start with the inspector for development debugging
pnpm mcp:inspect

# Build the MCP server (when you are ready to package)
pnpm mcp:build

Configuration and security

Set your API key securely to enable interactions with the Buttondown service. You have two options:

Environment variable: export BUTTONDOWN_API_KEY=your_api_key
1Password integration: store your API key in 1Password at op://Development/Buttondown API/notesPlain and let the integration fetch it when needed.

Usage examples for MCP server

The MCP server exposes a set of tools you can invoke from your MCP client. Common actions include listing emails, creating drafts, retrieving analytics, and scheduling drafts for sending.

When you are ready, start the MCP server and use the client to execute available tools against your Buttondown data.

Troubleshooting and notes

If you encounter issues starting the MCP server, ensure you have Node.js installed and that you are running the provided start command in the project’s environment. Check that your API key is available via environment variables or 1Password as configured.

Appendix: tool capabilities you can call from an MCP client

The MCP server exposes a set of actions you can invoke from your client to manage content and analytics.

Available tools

listEmails

List all emails with optional status filtering such as draft, scheduled, or sent.

createDraft

Create a new email draft with specified content and title.

getAnalytics

Retrieve analytics for a specific email or draft.

scheduleDraft

Schedule a draft for sending at a specified time.

getDrafts

List existing drafts and their statuses.

createEmail

Programmatic interface to create and manage emails via TypeScript.

scheduleEmail

Programmatic method to schedule an email delivery.

getEmailStats

Programmatic method to fetch analytics for an email.