Paystack 模型上下文协议(MCP)服务器允许AI代理通过标准化的MCP客户端与Paystack进行交互。此协议支持各种工具来与不同的Paystack服务进行交互。
确保用您的实际Paystack密钥替换your_paystack_secret_key_here。
要通过Smithery自动安装Paystack MCP:
npx -y @smithery/cli install @kohasummons/paystack-mcp --client claude
npm install -g @kohasummons/paystack-mcp
通过运行以下命令启动服务器:
paystack-mcp
或者在您的MCP配置中使用npx:
{
"mcpServers": {
"paystack-mcp": {
"command": "npx",
"args": [
"-y",
"@kohasummons/paystack-mcp"
],
"env": {
"PAYSTACK_SECRET_KEY": "your_paystack_secret_key_here"
}
}
}
}
</details>
<details>
<summary>与Claude Desktop一起使用</summary>
在您的claude_desktop_config.json中添加以下内容。更多详情请参见这里。
{
"mcpServers": {
"paystack-mcp": {
"command": "npx",
"args": ["-y", "@kohasummons/paystack-mcp"],
"env": {
"PAYSTACK_SECRET_KEY": "your_paystack_secret_key_here"
}
}
}
}
</details>
<details>
<summary>与Goose一起使用</summary>
将以下链接复制粘贴到浏览器地址栏以将此扩展添加到Goose桌面:
goose://extension?cmd=npx&arg=-y&arg=@kohasummons/paystack-mcp&id=paystack-m- cp&name=Paystack%20MCP&description=process%20payments%20with%20Paystack
安装后,在扩展设置中设置您的Paystack密钥。
</details> <details> <summary>与CLI一起使用</summary>全局安装包:
npm install -g @kohasummons/paystack-mcp
将您的Paystack密钥设置为环境变量:
export PAYSTACK_SECRET_KEY=your_paystack_secret_key_here # 对于macOS/Linux
# 或者
set PAYSTACK_SECRET_KEY=your_paystack_secret_key_here # 对于Windows
通过运行以下命令启动服务器:
paystack-mcp
或直接使用NPX:
PAYSTACK_SECRET_KEY=your_paystack_secret_key_here npx -y @kohasummons/paystack-mcp
</details>
<details>
<summary>与Cursor一起使用</summary>
在您的Cursor MCP配置中添加以下内容:
{
"mcpServers": {
"paystack-mcp": {
"command": "npx",
"args": ["-y", "@kohasummons/paystack-mcp"],
"env": {
"PAYSTACK_SECRET_KEY": "your_paystack_secret_key_here"
}
}
}
}
</details>
<details>
<summary>与Docker一起使用</summary>
您可以使用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"
]
}
}
}
{
"mcpServers": {
"paystack-mcp": {
"command": "docker",
"args": [
"run",
"--rm",
"-i",
"-e",
"PAYSTACK_SECRET_KEY=your_paystack_secret_key_here",
"kohasummons/paystack-mcp"
]
}
}
}
详细Docker说明请参见DOCKER.md。
</details>| 工具 | 描述 | 示例提示 |
|---|---|---|
| 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 | 初始化付款交易 | "开始为john@example.com客户的新付款,金额为5000奈拉" |
| verify_transaction | 验证交易状态 | "检查参考编号为TR_123456的交易状态" |
| fetch_transaction | 获取交易详细信息 | "获取交易ID 12345的详细信息" |
| list_transactions | 根据各种过滤器列出交易 | "显示上个月的所有成功交易" |
| charge_authorization | 收取之前已授权的卡 | "使用john@example.com客户保存的卡收取5000奈拉" |
| partial_debit | 从已授权的卡中收取部分金额 | "从john@example.com客户保存的卡中收取3000奈拉的部分金额" |
| deactivate_authorization | 停用付款授权 | "移除授权代码为AUTH_123的保存卡" |
| transaction_totals | 获取您账户收到的总金额 | "上个月我的账户收到了多少总金额?" |
| export_transactions | 导出交易列表 | "导出我2023年1月的所有交易" |
| 工具 | 描述 | 示例提示 |
|---|---|---|
| list_banks | 获取Paystack支持的银行列表 | "显示尼日利亚所有支持的银行" |
| list_countries | 获取Paystack支持的国家列表 | "Paystack支持哪些国家?" |
| list_states | 获取国家的州列表 | "列出尼日利亚的所有州,用于地址验证" |
我们欢迎贡献来帮助改进这个项目并实现剩余的Paystack API端点!还有许多其他Paystack功能可以作为工具添加,包括:
有关如何贡献的详细说明,请参见CONTRIBUTING.md,包括:
要参与此项目:
npm installnpm run buildnpm run dev:debug您需要将Paystack密钥设置为环境变量:
# 在项目根目录下创建一个.env文件
echo "PAYSTACK_SECRET_KEY=your_paystack_secret_key_here" > .env
要调试您的服务器,您可以使用MCP Inspector。
首先构建服务器
npm run build
在终端中运行以下命令:
# 启动MCP Inspector和服务器
npm run dev:debug
在Inspector UI中添加您的PAYSTACK_SECRET_KEY环境变量。开始调试吧!
有关使用Docker构建和运行的详细信息,请参见DOCKER.md。
MIT