MCP Server

The Model Context Protocol (MCP) is an open-source standard for connecting AI applications to external systems. Topsort provides an MCP server through Mintlify that gives AI assistants direct access to our complete API documentation, enabling them to provide accurate, up-to-date information about our APIs.

Tip

Think of MCP like a USB-C port for AI applications. Just as USB-C provides a standardized way to connect devices, MCP provides a standardized way to connect AI applications to external data sources like our API documentation.

What You Can Do

By connecting to Topsort’s MCP server, AI assistants can:

• Access complete API documentation - Query endpoint details, parameters, request/response schemas, and examples
• Get accurate integration guidance - Receive up-to-date code examples and implementation instructions
• Troubleshoot faster - Quickly reference error codes, rate limits, and authentication methods
• Stay current - Always access the latest API documentation without manual updates

Quick Start

Our MCP server is available at:

https://api.docs.topsort.com/mcp

Authentication

The MCP server is publicly accessible and doesn’t require authentication. However, you’ll need API keys to actually use the Topsort API in your applications.

Integration Guides

VS Code & GitHub Copilot

Use MCP with GitHub Copilot in Visual Studio Code

ChatGPT

Connect ChatGPT to access Topsort documentation

Claude Desktop

Configure Claude Desktop for local development

Other Clients

Cursor, Windsurf, Continue, and more

VS Code with GitHub Copilot

GitHub Copilot supports MCP servers in both the coding agent and the chat interface, allowing you to access Topsort’s API documentation directly within your IDE.

Prerequisites

• VS Code version 1.95.0 or later
• GitHub Copilot extension installed and activated
• GitHub Copilot Chat extension installed

Configuration

1. Open VS Code Settings

   Press Cmd+, (Mac) or Ctrl+, (Windows/Linux) to open Settings, or go to Code > Settings > Settings (Mac) or File > Preferences > Settings (Windows/Linux).

2. Navigate to MCP Configuration

   Search for “MCP” in the settings search bar, or navigate to:

   Extensions > GitHub Copilot > MCP

3. Add Topsort MCP Server

   Click Edit in settings.json to add the MCP server configuration. You can configure this at either the user or workspace level.

   For User Settings (~/.config/Code/User/settings.json on Mac/Linux or %APPDATA%\Code\User\settings.json on Windows):

   {
     "github.copilot.chat.mcp.servers": {
       "topsort": {
         "type": "sse",
         "url": "https://api.docs.topsort.com/mcp"
       }
     }
   }

   For Workspace Settings (.vscode/settings.json in your project):

   {
     "github.copilot.chat.mcp.servers": {
       "topsort": {
         "type": "sse",
         "url": "https://api.docs.topsort.com/mcp"
       }
     }
   }

4. Reload VS Code

   After saving the settings, reload VS Code to apply the changes:

   • Press Cmd+Shift+P (Mac) or Ctrl+Shift+P (Windows/Linux)
   • Type “Developer: Reload Window” and press Enter

5. Verify the Connection

   Open the GitHub Copilot Chat panel (click the chat icon in the sidebar or press Cmd+Shift+I / Ctrl+Shift+I), and you should see the Topsort MCP server listed as available.

Usage Examples

Once configured, GitHub Copilot can access Topsort’s API documentation in your conversations:

You: How do I create a banner campaign using the Topsort API?

Copilot: [Accesses Topsort MCP server] Based on the Topsort API documentation...

You: What are the required fields for the auctions API?

Copilot: [Retrieves endpoint details] The auctions endpoint requires...

Note

GitHub Copilot will automatically query the MCP server when it detects questions related to Topsort’s API. You can also explicitly mention “using the Topsort API” to ensure the MCP server is consulted.

ChatGPT

ChatGPT supports remote MCP servers, allowing you to access Topsort’s API documentation during your conversations.

Prerequisites

• ChatGPT Plus or ChatGPT Team subscription (MCP support is not available in the free tier)
• Access to ChatGPT’s web interface at chat.openai.com

Configuration

1. Open ChatGPT Settings

   Navigate to chat.openai.com and click your profile icon in the bottom-left corner, then select Settings.

2. Access Connections

   In the settings sidebar, click on Connections or Integrations (the exact menu name may vary).

3. Add MCP Server

   Look for the option to add a new MCP server or integration. Click Add Connection or + New Integration.

4. Configure Topsort Server

   Enter the following details:

   • Name: Topsort API Documentation
   • Server URL: https://api.docs.topsort.com/mcp
   • Transport Type: SSE (Server-Sent Events)
   • Authentication: None (leave blank)

5. Save and Enable

   Click Save or Connect, then make sure the integration is enabled/toggled on.

Usage Examples

Start a new conversation and ask questions about the Topsort API:

Example 1

You: “Using the Topsort API documentation, how do I implement sponsored listings?”

ChatGPT will query the MCP server and provide detailed implementation instructions based on the latest documentation.

Example 2

You: “What authentication methods does the Topsort API support?”

ChatGPT will retrieve the authentication section from the API documentation.

Example 3

You: “Show me a code example for creating a banner ad campaign”

ChatGPT will provide current code examples from the documentation.

Tip

For best results, explicitly mention “using the Topsort API” or “according to Topsort’s documentation” in your questions to ensure ChatGPT queries the MCP server.

Claude Desktop

Claude Desktop provides comprehensive local MCP support, making it ideal for development workflows.

Prerequisites

• Claude Desktop app installed (download here)
• macOS, Windows, or Linux operating system

Configuration

1. Open Claude Desktop Settings

   • macOS: Click Claude in the menu bar → Settings
   • Windows: Click File → Settings
   • Linux: Click File → Preferences

2. Navigate to Developer Tab

   In the Settings window, click on the Developer tab in the left sidebar.

3. Edit MCP Configuration

   Click the Edit Config button. This will open the 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

4. Add Topsort MCP Server

   Add the following configuration to the mcpServers object:

   {
     "mcpServers": {
       "topsort-api": {
         "type": "sse",
         "url": "https://api.docs.topsort.com/mcp",
         "description": "Topsort API Documentation"
       }
     }
   }

   If you have existing MCP servers configured, add the topsort-api entry to the existing mcpServers object.

5. Save and Restart

   Save the configuration file and completely quit and restart Claude Desktop.

6. Verify Connection

   After restarting, you should see a server/tools indicator (🔨) in the bottom-right corner of the chat input. Click it to view available tools and verify that the Topsort server is connected.

Usage

Claude can now access Topsort’s API documentation in your conversations:

You: Help me integrate the Topsort auctions API into my e-commerce platform

Claude: [Accesses Topsort documentation] I'll help you integrate the auctions API...

Note

Claude will request your approval before accessing the MCP server. Review and approve the request to allow Claude to fetch documentation.

Other MCP Clients

Topsort’s MCP server works with any MCP-compatible client. Here are popular options:

Cursor

Cursor is an AI-powered code editor with built-in MCP support.

Add to your Cursor settings (.cursor/config.json or via Settings UI):

{
  "mcp": {
    "servers": {
      "topsort": {
        "type": "sse",
        "url": "https://api.docs.topsort.com/mcp"
      }
    }
  }
}

Windsurf Editor

Windsurf is an agentic IDE with MCP support.

Configure in Windsurf settings or ~/.windsurf/mcp.json:

{
  "servers": {
    "topsort": {
      "type": "sse",
      "url": "https://api.docs.topsort.com/mcp"
    }
  }
}

Continue

Continue is an open-source AI code assistant for VS Code and JetBrains.

Add to ~/.continue/config.json:

{
  "mcpServers": {
    "topsort": {
      "transport": {
        "type": "sse",
        "url": "https://api.docs.topsort.com/mcp"
      }
    }
  }
}

Cline

Cline is an autonomous coding agent in VS Code.

Configure via the Cline extension settings or in ~/Documents/Cline/MCP/config.json:

{
  "topsort": {
    "type": "sse",
    "url": "https://api.docs.topsort.com/mcp"
  }
}

Troubleshooting

Connection Issues

Problem: MCP server not showing up or not connecting

Solutions:

• Verify the URL is correct: https://api.docs.topsort.com/mcp
• Check your internet connection
• Restart your MCP client application
• Review client-specific logs for error messages

Server Not Responding

Problem: Server appears connected but doesn’t respond to queries

Solutions:

• Verify the transport type is set to sse (Server-Sent Events)
• Check if your firewall or VPN is blocking the connection
• Try reconnecting or restarting the client
• Check our status page for any service disruptions

Getting Client Logs

Different clients store logs in different locations:

VS Code

• Open the Output panel (View > Output)
• Select GitHub Copilot or GitHub Copilot Chat from the dropdown
• Look for MCP-related messages

Claude Desktop

macOS: ~/Library/Logs/Claude/mcp.log

Windows: %APPDATA%\Claude\logs\mcp.log

Linux: ~/.local/state/Claude/logs/mcp.log

Other Clients

Check the client’s documentation for log file locations. Most clients store logs in their application data directory.

Use Cases

Faster Integration

Instead of constantly switching between your code editor and browser documentation:

You: How do I authenticate with the Topsort API?

AI: [Retrieves from MCP] Topsort uses API key authentication...

Accurate Code Generation

AI assistants with access to current documentation generate more accurate code:

You: Generate a function to run a banner auction

AI: [Uses latest API schema] Here's a function using the current auctions endpoint...

Troubleshooting

Quickly diagnose issues without leaving your development environment:

You: I'm getting a 400 error when creating a campaign

AI: [Checks error documentation] A 400 error typically indicates...

Learning and Exploration

Explore the API interactively:

You: What ad formats does Topsort support?

AI: [Queries documentation] Topsort supports the following ad formats...

Technical Details

Server Capabilities

The Topsort MCP server provides the following capabilities:

• Resources: Access to API documentation, guides, and examples
• Tools: Query capabilities for searching endpoints, schemas, and examples
• Prompts: Pre-configured prompts for common integration scenarios

Transport Protocol

• Type: Server-Sent Events (SSE)
• Protocol: HTTP/HTTPS
• Format: JSON-RPC 2.0

API Coverage

The MCP server provides access to:

• Complete OpenAPI specification
• All API endpoints and methods
• Request/response schemas
• Authentication documentation
• Rate limiting information
• Error codes and descriptions
• Integration guides and tutorials

Security & Privacy

• No Authentication Required: The MCP server provides read-only access to public documentation
• No Data Storage: The server doesn’t store your queries or conversations
• Direct Connection: Your AI client connects directly to the MCP server
• API Keys Separate: Your actual Topsort API keys are never sent through the MCP server

Caution

While the MCP server itself doesn’t require authentication, you’ll still need valid API keys to actually use the Topsort API in your applications. Never share your API keys in conversations or commit them to version control.

Learn More

• Model Context Protocol Documentation
• MCP Client List
• Topsort API Documentation
• GitHub Copilot MCP Guide