Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.boostgpt.co/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Paste an OpenAPI spec URL and BoostGPT automatically generates a working MCP server. No coding required.

​
Quick Start

1

Get OpenAPI URL

Find your API’s OpenAPI specification URL:
https://api.yourservice.com/openapi.json
2

Create Server

  • Go to Dashboard -> MCP Servers
  • Click Create Server
  • Select Import OpenAPI
3

Paste URL

Paste your OpenAPI spec URL and click Generate
4

Server Ready

BoostGPT generates your MCP server instantly:
https://mcp.your-server-id.boostgpt.co
5

Connect to Agent

  • Agent -> Tools tab -> Add Tool -> Add New
  • Enter your MCP URL
  • Start using in Playground

​
OpenAPI Format

Your OpenAPI spec should be in JSON or YAML format: 
openapi: 3.0.0
info:
  title: My API
  version: 1.0.0
servers:
  - url: https://api.example.com/v1
paths:
  /users:
    get:
      summary: List users
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
      responses:
        '200':
          description: Success
  /users:
    post:
      summary: Create user
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                email:
                  type: string

​
Auto-Generated Tools

BoostGPT converts each API endpoint into an agent tool:
API EndpointGenerated ToolDescription
GET /userslist_usersList users with optional limit
POST /userscreate_userCreate a new user
GET /users/{id}get_userGet user by ID
PUT /users/{id}update_userUpdate user information
DELETE /users/{id}delete_userDelete user

​
Example: CRM API

OpenAPI Spec: 
openapi: 3.0.0
info:
  title: CRM API
  version: 1.0.0
paths:
  /contacts:
    post:
      summary: Create contact
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                name:
                  type: string
                email:
                  type: string
                company:
                  type: string
  /deals:
    get:
      summary: List deals
      parameters:
        - name: status
          in: query
          schema:
            type: string
Generated Tools: 
Agent can now use:

1. create_contact
   - Parameters: name, email, company
   - Creates a new CRM contact

2. list_deals
   - Parameters: status (optional)
   - Lists deals filtered by status

​
Authentication

Add authentication to your OpenAPI spec: 
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
    BearerAuth:
      type: http
      scheme: bearer
security:
  - ApiKeyAuth: []
Configure credentials in Dashboard -> MCP Servers -> Your Server -> Settings

​
Testing

Test your MCP server after creation:
1

Add to Agent

Connect your MCP server to any agent
2

Open Playground

Go to agent’s Playground tab
3

Test Tools

User: "List all users in the system"
Agent: *uses list_users tool* "Found 25 users..."

User: "Create a contact named John Doe"
Agent: *uses create_contact tool* "Contact created successfully"

​
Common Issues

Ensure your URL returns valid OpenAPI 3.0+ JSON or YAML. Test it in a browser first.
Add security schemes to your OpenAPI spec and configure credentials in MCP server settings.
Check that your API endpoints return proper responses. Review error messages in agent Insights.

​
Best Practices

  1. Clear endpoint descriptions - AI uses descriptions to understand when to call tools
  2. Include examples - Add example requests/responses in your OpenAPI spec
  3. Document parameters - Describe what each parameter does
  4. Use semantic naming - Endpoint names like /users become tool names like list_users
  5. Version your API - Use /v1/ in paths to support multiple versions

​
Public APIs

Many public APIs provide OpenAPI specs: 
Stripe: https://raw.githubusercontent.com/stripe/openapi/master/openapi/spec3.json
GitHub: https://raw.githubusercontent.com/github/rest-api-description/main/descriptions/api.github.com/api.github.com.json
Import these to create custom connectors for public services.

​
Next Steps

Authentication

Configure API authentication

Postman Import

Alternative: Upload Postman collection