关于 mcp-asaas
mcp-asaas 是面向 Asaas 支付平台的 MCP 服务,提供 Pix、boleto、信用卡收款及订阅等账单自动化能力。适合需要让 AI Agent 处理收款与订阅流程的开发者。项目同时提供演示模式,无需 API 密钥即可测试工具调用。
主要功能
- 01覆盖 Pix、boleto 与信用卡收款
- 02支持信用卡分期付款与分期计划预览
- 03管理客户、订阅与 Webhook 通知配置
- 04查询余额、转账记录并支持退款
- 05演示模式返回固定数据,可无密钥测试
适用场景
- 01让 Agent 为客户生成 Pix 收款码或 boleto
- 02创建并取消周期性订阅
- 03在沙箱环境中测试收款流程
MCP 相关
该项目是 MCP 服务,向 MCP 客户端暴露 24 个 Asaas 相关工具,如 create_payment、get_pix_qrcode 和 create_subscription。
配置
本地服务的配置在各客户端中通用,复制后粘贴到客户端的 MCP 配置文件即可。
工具
24收录的工具列表 · 更新于 2 周前
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| value | number | 是 | 以 BRL 计的总金额 |
| dueDate | string | 是 | 首期分期付款的到期日(YYYY-MM-DD) |
| customer | string | 是 | 客户 ID(cus_xxx) |
| billingType | enum | 是 | 付款方式BOLETO | CREDIT_CARD | PIX |
| description | string | 否 | 付款说明 |
| installments | number | 否 | 等额分期付款的期数(>=2)。仅当 billingType 为 CREDIT_CARD 时有效。 |
详细介绍
@codespar/mcp-asaas
Asaas 的 MCP 服务——支持 Pix、boleto 和信用卡支付的账单自动化
快速开始
Claude Desktop
添加到 ~/.config/claude/claude_desktop_config.json:
{
"mcpServers": {
"asaas": {
"command": "npx",
"args": ["-y", "@codespar/mcp-asaas"],
"env": {
"ASAAS_API_KEY": "your-key",
"ASAAS_SANDBOX": "true"
}
}
}
}
Claude Code
claude mcp add asaas -- npx @codespar/mcp-asaas
Cursor / VS Code
添加到 .cursor/mcp.json 或 .vscode/mcp.json:
{
"servers": {
"asaas": {
"command": "npx",
"args": ["-y", "@codespar/mcp-asaas"],
"env": {
"ASAAS_API_KEY": "your-key",
"ASAAS_SANDBOX": "true"
}
}
}
}
工具(24 个)
| 工具 | 用途 |
|---|---|
create_payment | 在 Asaas 创建付款(Pix、boleto 或信用卡);将 installments(>=2)与 billingType: CREDIT_CARD 一起传入,可分期为等额月付款 |
get_payment | 按 ID 获取付款详情 |
list_payments | 列出付款,可选筛选条件 |
get_pix_qrcode | 获取付款的 Pix 二维码(返回有效载荷和图像) |
get_boleto | 获取付款的 boleto 数字支付行和条形码 |
create_customer | 在 Asaas 创建客户 |
list_customers | 列出客户,可选筛选条件 |
create_subscription | 创建定期订阅 |
get_balance | 获取当前账户余额 |
list_subscriptions | 列出订阅,可选筛选条件 |
cancel_subscription | 按 ID 取消订阅 |
get_webhook_events | 列出 Webhook 事件(付款确认、转账等) |
create_subaccount | 创建用于付款分账的子账户 |
get_installments | 通过 id 获取现有付款的分期详情;或不传入 id,改为传入 value + installments,预览假设的分期计划 |
create_transfer | 创建银行转账(Pix 转出或 TED) |
create_pix_qrcode | 生成用于收款的静态 PIX 二维码 |
list_transfers | 列出转账,可选筛选条件 |
create_notification | 创建 Webhook 通知配置 |
list_notifications | 列出 Webhook 通知配置 |
get_customer | 按 ID 获取客户详情 |
update_payment | 更新待处理的付款 |
delete_payment | 按 ID 删除付款 |
refund_payment | 退还已收取的付款 |
get_subscription | 按 ID 获取订阅详情 |
身份验证
Asaas 使用通过 access_token 标头传递的 API 密钥。你可以在 Asaas 控制面板中生成密钥。
沙盒 / 测试
Asaas 提供完整的沙盒环境,地址为 sandbox.asaas.com。设置 ASAAS_SANDBOX=true 即可使用。
获取凭据
- 访问 Asaas
- 创建账户,或前往 sandbox.asaas.com 注册沙盒账户
- 前往 Integracoes > API 并生成 API 密钥
- 设置
ASAAS_API_KEY环境变量
环境变量
| 变量 | 必填 | 描述 |
|---|---|---|
ASAAS_API_KEY | 是(演示模式除外) | Asaas 控制面板中的 API 密钥 |
ASAAS_SANDBOX | 否 | 设置为 "true" 以启用沙盒模式 |
MCP_DEMO | 否 | 设置为 "true"(相当于在命令行中传入 --demo),以使用有状态的演示模式样例数据——无需 API 密钥 |
演示模式
传入 --demo 标志(或设置 MCP_DEMO=true),即可让每个工具返回确定性的模拟响应,而不调用真实的
Asaas API。适用于构建和测试 Agent,无需消耗沙盒凭据。
create_payment 和 get_installments 的演示处理程序具有状态:create_payment 每次调用都会生成不同的 ID
(pay_demo_001、pay_demo_002……),并且在使用
billingType: CREDIT_CARD + installments >= 2 + value > 0 调用时,
会将分期计划记录到进程内账本中。随后针对该 ID 调用
get_installments({ id }) 时,会返回记录的分期计划。get_installments 还支持预览路径——不传入 id,而是传入 value + installments,即可返回假设的分期计划(status: "PREVIEW"、preview: true),但不会创建付款。其他工具会返回静态模拟数据。
# Start the server in demo mode (no key required):
npx -y @codespar/mcp-asaas --demo
路线图
v0.2(计划中)
list_subscriptions— 列出所有定期订阅,并支持筛选cancel_subscription— 取消有效订阅get_webhook_events— 列出 Webhook 事件,以便调试集成create_subaccount— 创建用于市场分账的子账户get_installments— 获取付款的分期详情
v0.3(计划中)
create_anticipation— 申请应收款提前结算get_fiscal_info— 获取付款的财税信息batch_payments— 在单个请求中创建多笔付款
链接
企业版
需要为 Agent 付款设置治理、预算限额和审计跟踪?CodeSpar Enterprise 在这些 MCP 服务的基础上提供策略引擎、付款路由和合规模板。
许可证
MIT
评论
一个开放协议,规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话,MCP 服务负责提供工具、资源和提示模板,两者通过标准消息通信,同一个服务可以被不同客户端复用。