AI导哈

通讯管理API集成

一个全面的TypeScript集成，用于Buttondown通讯服务，提供CLI界面和MCP服务器，用于管理通讯、草稿和分析。

  • by The-Focus-AI
  • TypeScript
  • 本地部署
  • 1 星标
  • 更新于
在 GitHub 查看 The-Focus-AI/buttondown-mcp

使用说明

Buttondown API集成

Buttondown时事通讯服务的全面TypeScript集成，提供CLI界面和模型上下文协议（MCP）服务器，用于管理时事通讯、草稿和分析。

特性

  • 多个接口:

    • 用于直接交互的命令行界面（CLI）
    • 用于AI/LLM集成的模型上下文协议（MCP）服务器
    • 用于自定义集成的Programmatic TypeScript API

  • 核心功能:

    • 电子邮件草稿管理（创建、更新、删除）
    • 电子邮件调度系统
    • 分析检索和格式化
    • 列表管理
    • 标签管理

  • 安全:

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

  • 开发者体验:

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

安装

# Install using pnpm (recommended)
pnpm install

# Or using npm
npm install

# Or using yarn
yarn install

配置

API密钥可以通过两种方式提供：

  1. 环境变量：

    export BUTTONDOWN_API_KEY=your_api_key

  2. 1Password命令行界面（推荐）：

    • 将您的API密钥存储在1Password中 op://Development/Buttondown API/notesPlain
    • 集成将在需要时自动获取它

用法

CLI接口

# List all emails
buttondown emails list

# Create a new draft
buttondown draft create <file>

# Schedule an email
buttondown schedule set <draft-id> <relative-time>

# Get analytics
buttondown analytics get <draft-id>

MCP服务器

  1. 启动服务器：

    pnpm mcp:start

  2. 从检查员开始（用于开发）：

    pnpm mcp:inspect

可用的MCP工具：

  • list_emails：列出所有具有可选状态过滤的电子邮件

    {
  "status": "draft" // Optional: "draft", "scheduled", "sent"
}

  • create_draft：创建新的电子邮件草稿

    {
  "content": "Email content in markdown",
  "title": "Optional email subject"
}

  • get_analytics：获取特定电子邮件的分析

    {
  "draftId": "email-id-here"
}

  • schedule_draft：安排电子邮件发送

    {
  "draftId": "email-id-here",
  "scheduledTime": "2024-03-27T10:00:00Z"
}

程序化使用

import { ButtondownAPI } from "api-integrator";

// Initialize the client
const api = new ButtondownAPI(); // Will use 1Password or env var

// List drafts
const drafts = await api.getDrafts();

// Create a draft
const draft = await api.createEmail({
  subject: "My Newsletter",
  body: "Content here",
  status: "draft",
});

// Schedule an email
const scheduled = await api.scheduleEmail(draft.id, "2024-03-27T10:00:00Z");

// Get analytics
const analytics = await api.getEmailStats(draft.id);

发展

# Build the project
pnpm build

# Run tests
pnpm test

# Start MCP server in development mode
pnpm mcp:inspect

# Build MCP server
pnpm mcp:build

测试

该项目包括几种类型的测试：

  • 核心功能的单元测试
  • API交互的集成测试
  • CLI命令测试
  • MCP服务器测试

使用以下工具运行测试：

pnpm test

项目结构

.
├── src/
│   ├── api/          # Core API client
│   ├── cli/          # CLI implementation
│   ├── mcp/          # MCP server
│   ├── types/        # TypeScript definitions
│   └── utils/        # Shared utilities
├── tests/            # Test files
├── api-responses/    # Cached API responses
└── memory-bank/      # Project documentation

贡献

  1. 分叉存储库
  2. 创建功能分支(git checkout -b feature/amazing-feature)
  3. 提交您的更改(git commit -m 'Add some amazing feature')
  4. 推到分支(git push origin feature/amazing-feature)
  5. 打开拉取请求

许可证

ISC许可证-请参阅 许可证 详见

致谢

相关 MCP