> ## Documentation Index
> Fetch the complete documentation index at: /docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Postman Collection Import

> Create MCP servers from Postman collections

## Overview

Upload a Postman collection and BoostGPT automatically generates a working MCP server. Your custom integration is live in under 5 minutes.

## Quick Start

**1. Export from Postman**

In Postman:

* Select your collection
* Click **Export**
* Choose **Collection v2.1**
* Save the JSON file

**2. Create Server**

* Go to **Dashboard -> MCP Servers**
* Click **Create Server**
* Select **Upload Postman Collection**

**3. Upload File**

Drop your Postman collection JSON file

**4. Server Generated**

BoostGPT generates your MCP server:

```text theme={null}
https://mcp.your-server-id.boostgpt.co
```

**5. Connect to your AI teammate**

* AI teammate -> **Tools** tab -> **Add Tool** -> **Add New**
* Enter your MCP URL
* Ready to use!

## Postman Collection Format

Your collection should be in Postman Collection v2.1 format:

```json theme={null}
{
  "info": {
    "name": "My API",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
  },
  "item": [
    {
      "name": "Get Users",
      "request": {
        "method": "GET",
        "header": [],
        "url": {
          "raw": "https://api.example.com/users?limit=10",
          "host": ["api", "example", "com"],
          "path": ["users"],
          "query": [
            {
              "key": "limit",
              "value": "10"
            }
          ]
        }
      }
    },
    {
      "name": "Create User",
      "request": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\"name\": \"John\", \"email\": \"john@example.com\"}"
        },
        "url": "https://api.example.com/users"
      }
    }
  ]
}
```

## Auto-Generated Tools

Each Postman request becomes an AI teammate tool:

| Postman Request | Generated Tool | Description |
| - | - | - |
| GET /users | `get_users` | Fetches user list |
| POST /users | `create_user` | Creates new user |
| GET /users/:id | `get_user_by_id` | Gets single user |
| PUT /users/:id | `update_user` | Updates user info |
| DELETE /users/:id | `delete_user` | Deletes user |

## Example: E-commerce API

**Postman Collection:**

```json theme={null}
{
  "info": {
    "name": "E-commerce API"
  },
  "item": [
    {
      "name": "Get Products",
      "request": {
        "method": "GET",
        "url": "https://api.shop.com/products"
      }
    },
    {
      "name": "Create Order",
      "request": {
        "method": "POST",
        "url": "https://api.shop.com/orders",
        "body": {
          "mode": "raw",
          "raw": "{\"product_id\": \"123\", \"quantity\": 2}"
        }
      }
    },
    {
      "name": "Get Order Status",
      "request": {
        "method": "GET",
        "url": "https://api.shop.com/orders/:orderId"
      }
    }
  ]
}
```

**Generated Tools:**

```text theme={null}
Teammate can now:

1. get_products
   - Lists available products

2. create_order
   - Parameters: product_id, quantity
   - Creates new order

3. get_order_status
   - Parameters: orderId
   - Checks order status
```

## Authentication

Add authentication to your Postman collection:

### API Key

```json theme={null}
{
  "auth": {
    "type": "apikey",
    "apikey": [
      {
        "key": "key",
        "value": "X-API-Key"
      },
      {
        "key": "value",
        "value": "{{api_key}}"
      }
    ]
  }
}
```

### Bearer Token

```json theme={null}
{
  "auth": {
    "type": "bearer",
    "bearer": [
      {
        "key": "token",
        "value": "{{access_token}}"
      }
    ]
  }
}
```

Configure credentials in **Dashboard -> MCP Servers -> Your Server -> Settings**

## Variables

Use Postman variables for dynamic values:

```json theme={null}
{
  "variable": [
    {
      "key": "base_url",
      "value": "https://api.example.com"
    },
    {
      "key": "api_key",
      "value": "your-api-key"
    }
  ]
}
```

Set variable values in MCP server settings after upload.

## Testing

Test your MCP server:

```text theme={null}
User: "Get all products from the store"

Teammate: *uses get_products tool*
       Found 50 products:
       1. Product A - $29.99
       2. Product B - $49.99
       ...

User: "Create an order for product 123, quantity 2"

Teammate: *uses create_order tool*
       Order created successfully!
       Order ID: ORD-456
```

## Organizing Collections

Use folders in Postman for better organization:

```json theme={null}
{
  "item": [
    {
      "name": "Users",
      "item": [
        {
          "name": "List Users",
          "request": {...}
        },
        {
          "name": "Create User",
          "request": {...}
        }
      ]
    },
    {
      "name": "Orders",
      "item": [
        {
          "name": "List Orders",
          "request": {...}
        }
      ]
    }
  ]
}
```

Tools are namespaced: `users_list_users`, `orders_list_orders`

## Common Issues

> [accordion] Invalid collection format
>
> Export as Collection v2.1 from Postman. Older formats aren't supported.

> [accordion] Authentication not working
>
> Add auth to your collection or configure credentials in MCP server settings after upload.

> [accordion] Request failing
>
> Test requests in Postman first to ensure they work. Check URLs and parameters.

> [accordion] Variables not resolving
>
> Set variable values in Dashboard -> MCP Servers -> Your Server -> Settings

## Best Practices

1. **Name requests clearly** - "Get User" becomes `get_user` tool
2. **Add descriptions** - Help AI understand when to use each tool
3. **Include examples** - Add example requests in Postman
4. **Test first** - Verify requests work in Postman before uploading
5. **Use folders** - Organize related endpoints together
6. **Document parameters** - Add parameter descriptions in Postman

## Example Collections

Download starter templates:

* **REST API Template** - Basic CRUD operations
* **E-commerce Template** - Product and order management
* **CRM Template** - Contact and deal management

## Next Steps

> [card] [Authentication](/docs/integrations/custom/authentication.md)
>
> Configure API authentication

> [card] [OpenAPI Import](/docs/integrations/custom/openapi.md)
>
> Alternative: Import OpenAPI spec


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.