Paybyrd Payment Processing MCP server for AI agents

This toolkit enables AI assistants to perform payment operations through the Paybyrd API, including creating payment links, processing refunds, and retrieving order information. It supports multiple AI platforms with a modular architecture.

Installation Requirements

Prerequisites

Node.js 18 or higher
Paybyrd API key
OpenAI API key (for OpenAI integration) or Anthropic API key (for Claude integration)

Package Installation

You can install each package separately depending on your AI platform of choice:

# For the core functionality
npm install @paybyrd/ai-agent-toolkit

# For Claude integration
npm install @paybyrd/ai-agent-claude

# For OpenAI integration
npm install @paybyrd/ai-agent-openai

Using the Toolkit

Available Payment Operations

The toolkit provides these key payment functions:

Create Payment Link: Generate payment links to send to customers
Create Refund: Process refunds for transactions
Retrieve Order: Get details about an existing order

Implementation Examples

OpenAI Implementation

To implement the toolkit with OpenAI:

// Import the OpenAI package
const { PaybyrdAgentOpenAI } = require('@paybyrd/ai-agent-openai');

// Initialize with your API keys
const agent = new PaybyrdAgentOpenAI({
  paybyrdApiKey: 'your-paybyrd-api-key',
  openaiApiKey: 'your-openai-api-key'
});

// Use the agent to process requests
const response = await agent.processRequest({
  message: "I need to create a payment link for $50"
});

console.log(response);

Claude Implementation with Model Context Protocol

To implement the toolkit with Claude:

// Import the Claude package
const { PaybyrdAgentClaude } = require('@paybyrd/ai-agent-claude');

// Initialize with your API keys
const agent = new PaybyrdAgentClaude({
  paybyrdApiKey: 'your-paybyrd-api-key',
  anthropicApiKey: 'your-anthropic-api-key'
});

// Use the agent to process requests
const response = await agent.processRequest({
  message: "I need to create a payment link for $50"
});

console.log(response);

Configuration Options

You can customize the agent behavior with additional configuration:

const agent = new PaybyrdAgentOpenAI({
  paybyrdApiKey: 'your-paybyrd-api-key',
  openaiApiKey: 'your-openai-api-key',
  // Optional configuration
  baseUrl: 'https://api.paybyrd.com/v1', // Custom API endpoint
  timeout: 30000, // Request timeout in milliseconds
  debug: true // Enable debug logging
});

Troubleshooting

Common Issues

API Key Errors: Ensure your Paybyrd and AI provider API keys are valid
Compatibility Issues: Verify you're using Node.js 18 or higher
Request Timeouts: Consider increasing the timeout value in the configuration

If you encounter persistent issues, check the response objects for detailed error information that can help identify the source of the problem.

How to install this MCP server

For Claude Code

To add this MCP server to Claude Code, run this command in your terminal:

claude mcp add-json "claude-paybyrd" '{"command":"npx","args":["-y","@paybyrd/ai-agent-claude"]}'

See the official Claude Code MCP documentation for more details.

For Cursor

There are two ways to add an MCP server to Cursor. The most common way is to add the server globally in the ~/.cursor/mcp.json file so that it is available in all of your projects.

If you only need the server in a single project, you can add it to the project instead by creating or adding it to the .cursor/mcp.json file.

Adding an MCP server to Cursor globally

To add a global MCP server go to Cursor Settings > Tools & Integrations and click "New MCP Server".

When you click that button the ~/.cursor/mcp.json file will be opened and you can add your server like this:

{
    "mcpServers": {
        "claude-paybyrd": {
            "command": "npx",
            "args": [
                "-y",
                "@paybyrd/ai-agent-claude"
            ]
        }
    }
}

Adding an MCP server to a project

To add an MCP server to a project you can create a new .cursor/mcp.json file or add it to the existing one. This will look exactly the same as the global MCP server example above.

How to use the MCP server

Once the server is installed, you might need to head back to Settings > MCP and click the refresh button.

The Cursor agent will then be able to see the available tools the added MCP server has available and will call them when it needs to.

You can also explicitly ask the agent to use the tool by mentioning the tool name and describing what the function does.

For Claude Desktop

To add this MCP server to Claude Desktop:

1. Find your configuration file:

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Windows: %APPDATA%\Claude\claude_desktop_config.json
Linux: ~/.config/Claude/claude_desktop_config.json

2. Add this to your configuration file:

{
    "mcpServers": {
        "claude-paybyrd": {
            "command": "npx",
            "args": [
                "-y",
                "@paybyrd/ai-agent-claude"
            ]
        }
    }
}

3. Restart Claude Desktop for the changes to take effect