Payman MCP server

This MCP server provides easy access to Payman AI's documentation, helping developers build integrations more efficiently by allowing AI assistants like Claude or Cursor to access Payman's documentation when answering integration questions.

Prerequisites

Before installation, ensure you have:

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

Installation Steps

1. Clone the Repository

git clone https://github.com/Vanshika-Rana/payman-mcp-server.git

2. Navigate to the Project Directory

cd payman-mcp-server

3. Install Dependencies

Using npm:

npm install

Or using yarn:

yarn install

4. Build the Project

Compile the TypeScript code into JavaScript:

npm run build

Or with yarn:

yarn build

Using the Server

Verify Installation

Check if the server is properly set up by running:

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

Connecting with AI Assistants

Once the server is running correctly, you can add the Payman MCP server to your preferred AI client:

• For Claude Desktop: Follow the integration instructions here
• For Cursor: Follow the integration guide here

With a successful connection, your AI assistant will now be able to access Payman's documentation when answering your integration questions, providing more accurate and helpful responses.

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

3. Restart Claude Desktop for the changes to take effect