Buttondown MCP

🚀 Buttondown API 集成

本項目是一個全面的 TypeScript 實現方案，用於集成 Buttondown 時事通訊服務。它提供了命令行界面 (CLI) 和模型上下文協議 (MCP) 服務器，能幫助用戶高效管理時事通訊、草稿以及分析數據，極大提升了時事通訊管理的便捷性和效率。

✨ 主要特性

• 多接口設計：
  • 命令行界面 (CLI)，讓用戶可以直接與系統進行交互。
  • 模型上下文協議 (MCP) 服務器，為 AI/LLM 集成提供支持。
  • 自定義整合的 TypeScript API，滿足多樣化的開發需求。
• 核心功能豐富：
  • 支持時事通訊草稿的創建、更新和刪除操作。
  • 具備時事通訊排期系統，方便用戶提前規劃發送時間。
  • 可獲取並格式化分析數據，為決策提供數據支持。
  • 能夠進行列表管理和標籤管理，優化信息組織。
• 安全性能卓越：
  • 集成 1Password 進行 API 密鑰管理，保障密鑰安全。
  • 支持通過環境變量配置 API 密鑰，提供靈活的配置方式。
  • 採用安全的憑證處理機制，防止信息洩露。
• 開發者體驗良好：
  • 提供全面的 TypeScript 支持，提升開發效率。
  • 擁有全面的類型定義，確保代碼的準確性和可維護性。
  • 類型基於實際 API 響應，與實際業務緊密結合。
  • 內置測試工具，方便開發者進行代碼測試。

📦 安裝指南

# 使用 pnpm（推薦）
pnpm install

# 或使用 npm
npm install

# 或使用 yarn
yarn install

💻 使用示例

配置

API 密鑰可通過以下兩種方式提供：

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 集成框架