README
🚀 签证受理代理工具包
签证受理代理工具包可与 Vercel 的 AI SDK 以及用于签证受理 API 的模型上下文协议(MCP)实现无缝集成。它提供了一套专门的工具,旨在帮助你管理发票、创建支付链接以及执行其他与签证受理相关的操作。
🚀 快速开始
本工具包可与 Vercel 的 AI SDK 和模型上下文协议(MCP)集成,助力你完成签证受理相关的操作。以下是使用本工具包的相关信息。
✨ 主要特性
- Vercel AI SDK - 与函数调用和工具支持实现全面集成
- 模型上下文协议(MCP) - 完整的 MCP 服务器实现
📦 安装指南
TypeScript
如果你只是想使用该工具包而不修改其源代码,请通过以下命令进行安装:
npm install @visaacceptance/agent-toolkit
要求
- Node 18+
💻 使用示例
基础用法
使用你的签证受理账户凭证配置工具包。这些凭证可以通过环境变量(MERCHANT_ID、API_KEY_ID、SECRET_KEY)进行设置。
import { VisaAcceptanceAgentToolkit } from "@visaacceptance/agent-toolkit/ai-sdk";
const toolkit = new VisaAcceptanceAgentToolkit({
merchantId: process.env.VISA_ACCEPTANCE_MERCHANT_ID,
apiKeyId: process.env.VISA_ACCEPTANCE_API_KEY_ID,
secretKey: process.env.VISA_ACCEPTANCE_SECRET_KEY,
configuration: {
actions: {
invoices: {
create: true,
update: true,
list: true,
get: true,
send: true,
cancel: true
},
paymentLinks: {
create: true,
update: true,
list: true,
get: true,
},
},
},
});
高级用法
与 Vercel 的 AI SDK 集成
要将此工具包与 Vercel 的 AI SDK 一起使用:
import { AI } from "@vercel/ai";
import { VisaAcceptanceAgentToolkit } from "@visaacceptance/agent-toolkit/ai-sdk";
const toolkit = new VisaAcceptanceAgentToolkit({
merchantId: process.env.MERCHANT_ID,
apiKeyId: process.env.API_KEY_ID,
secretKey: process.env.SECRET_KEY,
configuration: {
actions: {
invoices: {
create: true,
}
},
},
});
const ai = new AI({
tools: toolkit.getTools(),
});
// 示例用法:
const response = await ai.run({
messages: [{ role: "user", content: "Please create an invoice for $200" }],
});
设置上下文
你可以通过 configuration.context 块设置默认行为或环境。例如,启用测试环境:
const toolkit = new VisaAcceptanceAgentToolkit({
merchantId: process.env.MERCHANT_ID,
apiKeyId: process.env.API_KEY_ID,
secretKey: process.env.SECRET_KEY,
configuration: {
context: {
environment: "SANDBOX",
},
},
});
🔧 技术细节
模型上下文协议
模型上下文协议(MCP) 也受支持。你可以使用以下命令运行签证受理 MCP 服务器:
npx -y @visaacceptance/mcp --tools=all --merchant-id=YOUR_MERCHANT_ID --api-key-id=YOUR_API_KEY_ID --secret-key=YOUR_SECRET_KEY
支持的 API 方法
该工具包目前提供以下签证受理操作:
- 发票
- 创建发票 - 使用客户信息和增强参数创建新发票
- 更新发票 - 更新现有发票的详细信息,包括客户和发票信息
- 列出发票 - 使用过滤选项检索分页的发票列表
- 获取发票 - 检索特定发票的详细信息
- 发送发票 - 通过电子邮件将发票发送给客户
- 取消发票 - 取消现有发票
- 支付链接
- 创建支付链接 - 使用可选的运输信息创建新的支付链接
- 更新支付链接 - 更新现有支付链接的详细信息
- 列出支付链接 - 检索分页的支付链接列表
- 获取支付链接 - 检索特定支付链接的详细信息
📄 许可证
本项目采用 MIT 许可证。
⚠️ 重要提示
AI 生成的内容可能不准确或不完整。用户在依赖任何信息之前,尤其是在进行财务决策时,应完全负责核实信息。签证受理方对因 AI 输出或本工具包导致的任何使用、决策或损害不承担责任。
Scan to join WeChat group