Buttondown API 集成

一个全面的 TypeScript 实现，用于集成 Buttondown 时事通讯服务，提供命令行界面 (CLI) 和模型上下文协议 (MCP) 服务器，以管理时事通讯、草稿和分析。

功能

• 多接口：

  • 命令行界面 (CLI)，可直接交互
  • 模型上下文协议 (MCP) 服务器，支持 AI/LLM 集成
  • 自定义整合的 TypeScript API

• 核心功能：

  • 时事通讯草稿管理（创建、更新、删除）
  • 时事通讯排期系统
  • 分析数据获取和格式化
  • 列表管理
  • 标签管理

• 安全性：

  • 1Password 集成，用于 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`：创建新的电子邮件草稿

  ```json
  {
    "subject": "字符串",
    "content": "字符串",
    "list_id": "string"
  }```

### 开发人员指南

项目结构如下：

src/ ├── cli.ts - 实现 CLI 界面 ├── mcp-server.ts - 实现 MCP 服务器 └── types.ts - 定义与 Buttondown API 交互的类型

测试命令：
```bash
pnpm test

开发命令：

pnpm dev

贡献指南

• 为项目提交拉取请求前，请确保代码遵循项目编码规范。
• 提交问题或功能请求至项目的 GitHub 仓库。

许可证

• 本项目遵守 MIT License 协议。

致谢

• 感谢 Buttondown 提供了优秀的时事通讯服务
• 感谢 模型上下文协议 提供的 AI 集成框架