Paid MCP Server

A Model Context Protocol (MCP) server that provides access to the Paid platform's customer data through MCP tools.

Features

• list_customers: Retrieve a list of customers from the Paid platform

Setup

Prerequisites

• Node.js v18.x or higher
• A Paid platform API token

Installation

1. Install dependencies:

npm install

2. Build the TypeScript code:

npm run build

3. Set up your Paid API token. You can do this in two ways:

   Option 1: Environment variable

   export PAID_TOKEN="your_paid_api_token_here"

   Option 2: Command line argument

   # The token will be passed when starting the server
   # See running instructions below

Running the Server

You can run the server using either an environment variable or command line argument for the token:

Option 1: Using environment variable

# For development:
npm run dev

# For production:
npm start

Option 2: Using command line argument

# For development:
npm run build && node dist/index.js --token your_paid_api_token_here

# For production:
node dist/index.js --token your_paid_api_token_here

# Short form:
node dist/index.js -t your_paid_api_token_here

Configuration

The server requires a Paid platform API token, which can be provided in two ways:

1. Environment variable: PAID_TOKEN
2. Command line argument: --token or -t

The command line argument takes precedence over the environment variable if both are provided.

Usage with MCP Clients

This server implements the Model Context Protocol and can be used with any MCP-compatible client. The server communicates over stdio.

Example Configuration for Claude Desktop

Add the following to your Claude Desktop configuration:

Option 1: Using environment variable

{
  "mcpServers": {
    "paid": {
      "command": "node",
      "args": ["/path/to/paid-mcp/dist/index.js"],
      "env": {
        "PAID_TOKEN": "your_paid_api_token_here"
      }
    }
  }
}

Option 2: Using command line argument

{
  "mcpServers": {
    "paid": {
      "command": "node",
      "args": ["/path/to/paid-mcp/dist/index.js", "--token", "your_paid_api_token_here"]
    }
  }
}

Available Tools

list_customers

Retrieves a list of customers from the Paid platform.

Parameters: None

Returns: JSON array of customer objects

Development

Project Structure

├── src/
│   └── index.ts          # Main server implementation
├── dist/                 # Compiled JavaScript output
├── package.json          # Project configuration
├── tsconfig.json         # TypeScript configuration
└── README.md            # This file

Building

npm run build

Testing

You can test the server using the MCP Inspector:

Using environment variable:

PAID_TOKEN=your_token npx @modelcontextprotocol/inspector node dist/index.js

Using command line argument:

npx @modelcontextprotocol/inspector node dist/index.js --token your_token

Error Handling

The server includes comprehensive error handling:

• Missing token (neither PAID_TOKEN environment variable nor --token argument provided)
• Network errors when connecting to the Paid API
• Invalid API responses
• Server startup failures

All errors are returned as text content through the MCP protocol.

License

ISC