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