Buttondown

🚀 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 emails draft new

# テストメールを送信する
buttonton emails send --test

# ヘルプ情報を取得する
buttondown help

MCPサーバー

MCPサーバーはAIモデルとのインタラクション用のインターフェースで、以下の操作をサポートしています。

• コンテキストを取得する：

  curl -X GET "http://localhost:1234/api/v1/context"
  

• コンテキストを設定する：

  curl -X POST "http://localhost:1234/api/v1/context" \
    -H "Content-Type: application/json" \
    -d '{"context": {"key": "value"}}'
  

高度な使用法

プログラム型使用

import { Buttondown } from '@buttondown/buttondown-api';

const buttondown = new Buttondown({
  apiKey: 'your_api_key',
});

// 新しい下書きを作成する
async function createDraft() {
  try {
    const response = await buttondown.drafts.create();
    console.log('下書きが作成されました:', response);
  } catch (error) {
    console.error('エラー:', error);
  }
}

🔧 開発

# 依存関係をインストールする
npm install

# 開発サーバーを起動する
npm run dev

# テストを実行する
npm test

プロジェクト構造

• src/：主要なソースコードファイルが含まれています。
• public/：ビルド後の静的リソースファイルが含まれています。
• node_modules/：自動的にインストールされる依存関係が含まれています。
• package.json：プロジェクトの依存関係管理と実行スクリプトが定義されています。
• .env：環境変数の設定ファイルです。

🤝 貢献ガイド

1. リポジトリをフォークする：

   git clone https://github.com/yourusername/buttondown-api.git
   cd buttondown-api
   

2. 機能ブランチを作成する：

   git checkout -b feature/new-feature
   

3. 変更をコミットする：

   git add .
   git commit -m "新機能を追加"
   git push origin feature/new-feature
   

4. プルリクエストを作成する： コミット後、GitHub を訪問して新しいプルリクエストを作成します。

📄 ライセンス

このプロジェクトはMITライセンスの下で提供されています。詳細については LICENSE を参照してください。

🙏 謝辞

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