Buttondown MCP

🚀 Buttondown API 統合

Buttondownニュースレターサービスを統合するための包括的なTypeScript実装です。コマンドラインインターフェース (CLI) とモデルコンテキストプロトコル (MCP) サーバーを提供し、ニュースレター、下書き、分析を管理できます。

✨ 主な機能

多様なインターフェース

• 直接対話可能なコマンドラインインターフェース (CLI)
• AI/LLM統合をサポートするモデルコンテキストプロトコル (MCP) サーバー
• カスタム統合用のTypeScript API

主要機能

• ニュースレター下書きの管理（作成、更新、削除）
• ニュースレターのスケジュール設定システム
• 分析データの取得と整形
• リスト管理
• タグ管理

セキュリティ

• APIキー管理用の1Password統合
• 環境変数のサポート
• 安全なクレデンシャル処理

開発者体験

• 包括的なTypeScriptサポート
• 完全な型定義
• 実際のAPIレスポンスに基づく型
• 組み込みのテストツール

📦 インストール

# pnpmを使用する場合（推奨）
pnpm install

# またはnpmを使用する場合
npm install

# またはyarnを使用する場合
yarn install

📚 ドキュメント

設定

APIキーは以下の2つの方法で提供できます。

1. 環境変数を使用する方法：

   export BUTTONDOWN_API_KEY=your_api_key
   

2. 1Password CLIを使用する方法（推奨）：

   • APIキーを1Passwordの op://Development/Buttondown API/notesPlain に保存します。
   • 統合プログラムは必要に応じて自動的に取得します。

使用方法

コマンドラインインターフェース (CLI)

# すべてのメールをリスト表示
buttondown emails list

# 新しい下書きを作成
buttondown draft create <ファイル>

# メールの送信をスケジュール設定
buttondown schedule set <draft-id> <相対時間>

# 分析データを取得
buttondown analytics get <draft-id>

MCPサーバー

1. サーバーを起動する：

   pnpm mcp:start
   

2. デバッグ機能付きで起動する（開発時）：

   pnpm mcp:inspect
   

利用可能なMCPツール：

• list_emails：すべてのメールをリスト表示し、状態でフィルタリングできます。

  {
    "status": "draft" // オプション: "draft"、"scheduled"、"送信中"
  }
  

• create_email：新しいメール下書きを作成します。

  {
    "subject": "文字列",
    "content": "文字列",
    "list_id": "string"
  }
  

開発者ガイド

プロジェクトの構造は以下の通りです。

src/
├── cli.ts - CLIインターフェースを実装
├── mcp-server.ts - MCPサーバーを実装
└── types.ts - Buttondown APIとのやり取りに使用する型を定義

テストコマンド：

pnpm test

開発コマンド：

pnpm dev

貢献ガイド

• プロジェクトにプルリクエストを送信する前に、コードがプロジェクトのコーディング規約に従っていることを確認してください。
• 問題や機能リクエストは、プロジェクトのGitHubリポジトリに提出してください。

📄 ライセンス

• このプロジェクトは MIT License の条項に従います。

謝辞

• Buttondown が優れたニュースレターサービスを提供してくれたことに感謝します。
• モデルコンテキストプロトコル がAI統合フレームワークを提供してくれたことに感謝します。