Buttondown

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