PaymanAI MCP server for AI agents

The Payman AI Documentation MCP Server provides AI assistants like Claude or Cursor with access to Payman's documentation, helping developers solve integration questions more efficiently by enhancing the AI's ability to provide accurate information about Payman's capabilities.

Prerequisites

Before installing the MCP server, ensure you have:

Node.js (v14 or higher)
npm or yarn
Git

Installation

Follow these steps to set up the Payman documentation MCP server:

Clone the repository:

git clone https://github.com/PaymanAI/payman-doc-mcp-server

Navigate to the project directory:
```
cd payman-doc-mcp-server
```
Install dependencies:
```
npm install
# OR
yarn install
```

Building and Running

Building the Project

Compile the TypeScript code into JavaScript:

npm run build
# OR
yarn build

Testing the Server

Verify that your server is properly set up:

node /ABSOLUTE/PATH/TO/PARENT/FOLDER/payman-doc-mcp-server/build/index.js

If the server starts successfully, you'll be ready to integrate it with AI assistants.

Connecting to AI Assistants

After confirming the server is running correctly, you can connect it to your preferred AI assistant:

Claude Desktop Integration

To add the Payman MCP server to Claude Desktop, follow the instructions here.

Cursor Integration

For Cursor users, integration instructions can be found here.

Usage

Once configured, your AI assistant will automatically have access to Payman's documentation when you ask questions about Payman integration. The assistant can now provide more accurate responses that reflect the current state of Payman's API and features.

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 "payman-doc-mcp-server" '{"command":"node","args":["PATH_TO_PARENT_FOLDER/payman-doc-mcp-server/build/index.js"]}'

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": {
        "payman-doc-mcp-server": {
            "command": "node",
            "args": [
                "PATH_TO_PARENT_FOLDER/payman-doc-mcp-server/build/index.js"
            ]
        }
    }
}

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": {
        "payman-doc-mcp-server": {
            "command": "node",
            "args": [
                "PATH_TO_PARENT_FOLDER/payman-doc-mcp-server/build/index.js"
            ]
        }
    }
}

3. Restart Claude Desktop for the changes to take effect