Buttondown API Integration

Buttondown API Integration

site icon
2025.03.24 0
TypeScript新闻稿管理邮件营销自动化交流协作
Buttondown API Integration 是一个全面的 TypeScript 集成,用于 Buttondown 新闻稿服务。它提供了命令行界面(CLI)和模型上下文协议(MCP)服务器,用于管理新闻稿、草稿和分析。
View on GitHub

Overview

基本能力

产品定位

Buttondown API Integration 是一个用于管理新闻稿服务的工具,支持通过 CLI 和 MCP 服务器进行交互,适用于开发者和 AI/LLM 集成。

核心功能

  • 多接口支持
  • 命令行界面(CLI)
  • 模型上下文协议(MCP)服务器
  • 编程式 TypeScript API

  • 核心功能

  • 邮件草稿管理(创建、更新、删除)
  • 邮件调度系统
  • 分析数据检索和格式化
  • 列表管理
  • 标签管理

  • 安全性

  • 1Password 集成用于 API 密钥管理
  • 环境变量支持
  • 安全凭证处理

  • 开发者体验

  • 完整的 TypeScript 支持
  • 全面的类型定义
  • 基于真实 API 响应的类型
  • 内置测试工具

适用场景

  • 新闻稿管理
  • 邮件营销自动化
  • AI/LLM 集成

工具列表

  • list_emails: 列出所有邮件,支持状态过滤
  • create_draft: 创建新的邮件草稿
  • get_analytics: 获取特定邮件的分析数据
  • schedule_draft: 调度邮件发送

常见问题解答

  • 如何提供 API 密钥?
  • 通过环境变量 BUTTONDOWN_API_KEY
  • 通过 1Password CLI

使用教程

使用依赖

确保已安装 Node.js 和 npm/yarn/pnpm。

安装教程

# 使用 pnpm(推荐)
pnpm install

# 使用 npm
npm install

# 使用 yarn
yarn install

调试方式

# 启动 MCP 服务器
pnpm mcp:start

# 开发模式下启动 MCP 服务器
pnpm mcp:inspect

# 运行测试
pnpm test

许可证

该项目遵循 ISC 开源许可条款。