使用说明
Paystack MCP服务器
Paystack 模型上下文协议 (MCP)服务器允许AI代理通过标准化的MCP客户端通过工具调用与Paystack交互。该协议支持各种工具与不同的Paystack服务进行交互。
特性
- 在您的Paystack商店中创建和管理产品
- 处理客户管理(创建、列出、更新、验证)
- 处理交易(初始化、验证、收费授权)
- 管理授权和付款
- 访问银行信息和国家数据
- 导出交易数据并查看交易总额
设置
确保更换 your_paystack_secret_key_here 使用您实际的Paystack密钥。
Installing via Smithery
通过以下方式自动安装克劳德桌面的Paystack MCP 史密瑟里:
npx -y @smithery/cli install @kohasummons/paystack-mcp --client claude
手动安装
npm install -g @kohasummons/paystack-mcp
用法
通过运行以下命令启动服务器:
paystack-mcp
或与 npx 在MCP配置中:
{
"mcpServers": {
"paystack-mcp": {
"command": "npx",
"args": [
"-y",
"@kohasummons/paystack-mcp"
],
"env": {
"PAYSTACK_SECRET_KEY": "your_paystack_secret_key_here"
}
}
}
}
Using with Claude Desktop
将以下内容添加到您的 claude_desktop_config.json。参见 这里 了解更多详情。
{
"mcpServers": {
"paystack-mcp": {
"command": "npx",
"args": ["-y", "@kohasummons/paystack-mcp"],
"env": {
"PAYSTACK_SECRET_KEY": "your_paystack_secret_key_here"
}
}
}
}
Using with Goose
将以下链接复制并粘贴到浏览器地址栏中,以将此扩展添加到鹅桌面:
goose://extension?cmd=npx&arg=-y&arg=@kohasummons/paystack-mcp&id=paystack-mcp&name=Paystack%20MCP&description=process%20payments%20with%20Paystack
安装后,在扩展设置中设置您的Paystack密钥。
Using with CLI
全局安装软件包:
npm install -g @kohasummons/paystack-mcp
将您的Paystack密钥设置为环境变量:
export PAYSTACK_SECRET_KEY=your_paystack_secret_key_here # For macOS/Linux
# OR
set PAYSTACK_SECRET_KEY=your_paystack_secret_key_here # For Windows
通过运行以下命令启动服务器:
paystack-mcp
或者直接与NPX一起使用:
PAYSTACK_SECRET_KEY=your_paystack_secret_key_here npx -y @kohasummons/paystack-mcp
Using with Cursor
将此添加到您的Cursor MCP配置中:
{
"mcpServers": {
"paystack-mcp": {
"command": "npx",
"args": ["-y", "@kohasummons/paystack-mcp"],
"env": {
"PAYSTACK_SECRET_KEY": "your_paystack_secret_key_here"
}
}
}
}
Using with Docker
您可以通过Docker运行Paystack MCP服务器:
塑造形象
docker-compose build
作为独立服务器运行
docker-compose up -d
与光标一起使用
添加到您的 .cursor/mcp.json:
{
"mcpServers": {
"paystack-mcp": {
"command": "docker",
"args": [
"run",
"--rm",
"-i",
"-e",
"PAYSTACK_SECRET_KEY=your_paystack_secret_key_here",
"kohasummons/paystack-mcp"
]
}
}
}
与Claude Desktop一起使用
{
"mcpServers": {
"paystack-mcp": {
"command": "docker",
"args": [
"run",
"--rm",
"-i",
"-e",
"PAYSTACK_SECRET_KEY=your_paystack_secret_key_here",
"kohasummons/paystack-mcp"
]
}
}
}
看 医生.md 了解详细的Docker说明。
工具
产品
| 工具 | 描述 | 示例提示 |
|---|---|---|
| create_product | 创建新产品 | “创建一个名为'高级计划'的新产品,价格为5000奈拉” |
| list_products | 列出所有产品 | “显示我Paystack商店中的所有产品” |
| get_product | 获取特定产品的详细信息 | “获取产品ID 12345的详细信息” |
| update_product | 更新现有产品的详细信息 | “将产品ID 12345的价格更新为6000奈拉” |
客户
| 工具 | 描述 | 示例提示 |
|---|---|---|
| create_customer | 创建新客户 | “使用电子邮件创建新客户john@example.com" |
| list_customers | 列出所有客户 | “显示我的所有客户” |
| get_customer | 获取特定客户的详细信息 | “通过电子邮件获取客户的详细情况john@example.com" |
| update_customer | 更新客户详细信息 | “将John Doe的电话号码更新为+2341234567890” |
| validate_customer | 使用银行账户验证客户身份 | “使用银行账户详细信息验证客户CUS_123” |
| set_customer_risk_action | 将客户列入白名单或黑名单 | “将客户CUS_123列入交易黑名单” |
交易
| 工具 | 描述 | 示例提示 |
|---|---|---|
| initialize_transaction | 初始化付款交易 | “为客户开始5000奈拉的新付款john@example.com" |
| verify_transaction | 验证交易状态 | “使用参考TR_123456检查交易状态” |
| fetch_transaction | 获取交易详细信息 | “获取交易ID 12345的详细信息” |
| list_transactions | 列出具有各种过滤器的交易 | “显示上个月所有成功的交易” |
| charge_authorization | 向以前授权的卡收费 | “向客户收费john@example.com5000奈拉使用他们的储蓄卡” |
| partial_debit | 从授权卡中收取部分金额 | “从john@example.com的已保存卡” |
| deactivate_authorization | 停用支付授权 | “删除授权码为AUTH_123的已保存卡” |
| transaction_totals | 获取您账户收到的总金额 | “上个月我账户收到的总额是多少?” |
| export_transactions | 导出交易列表 | “导出2023年1月以来的所有交易” |
银行信息
| 工具 | 描述 | 示例提示 |
|---|---|---|
| list_banks | 获取Paystack支持的银行列表 | “显示尼日利亚所有支持的银行” |
| list_countries | 获取Paystack支持的国家列表 | “Paystack支援哪些国家?” |
| list_states | 获取一个国家的州列表 | “列出尼日利亚的所有州以进行地址验证” |
贡献
我们欢迎为帮助改进此项目并实现剩余的Paystack API端点做出贡献!还有更多Paystack功能可以添加为工具,包括:
- 付款页面
- 子账户
- 计划
- 订阅
- 苹果支付
- 虚拟账户
- 发票
- 退款
- 还有更多!
看 贡献.md 有关如何贡献的详细说明,包括:
- 设置您的开发环境
- 新工具实施指南
- 代码风格指南
- 拉取请求流程
发展
要完成此项目,请执行以下操作:
- 克隆存储库
- 安装依赖项:
npm install - 构建项目:
npm run build - 运行检查器:
npm run dev:debug
您需要将Paystack密钥设置为环境变量:
# Create a .env file in the project root
echo "PAYSTACK_SECRET_KEY=your_paystack_secret_key_here" > .env
调试
要调试服务器,可以使用 MCP检查员.
首先构建服务器
npm run build
在终端中运行以下命令:
# Start MCP Inspector and server
npm run dev:debug
添加您的 PAYSTACK_SECRET_KEY 到检查器UI中的环境变量。调试走!
Docker支持
看 医生.md 有关构建和运行Docker的详细信息。
许可证
麻省理工学院