# Connect to ShipStation Documentation MCP

Accelerate your API integration development by connecting the ShipStation Documentation MCP server to your AI assistant. This server provides intelligent access to the complete ShipStation API documentation, enabling your AI tools to help you explore endpoints, understand schemas, and implement integrations faster.

About This MCP Server
This MCP server provides access to **API documentation and reference materials**. It enables AI assistants to explore the ShipStation API specs, explain endpoints, and guide your integration work. For direct API operations, use the ShipStation API with your credentials.

## What You Can Do

Once connected, your AI assistant can:

- **Explore API Endpoints** - Discover available operations across all ShipStation resources
- **Understand Request/Response Structures** - View detailed schemas and data models
- **Get Contextual Guidance** - Receive explanations tailored to specific endpoints
- **Access Code Examples** - Find implementation patterns and best practices
- **Navigate Documentation** - Query guides, tutorials, and reference materials


This is particularly useful when:

- Learning the ShipStation API for the first time
- Implementing new integration features
- Troubleshooting API responses
- Understanding complex workflows (rates, shipping, fulfillments, etc.)


## Prerequisites

- One of the supported AI tools installed (Claude Code, Cursor, or VS Code)
- Basic familiarity with REST APIs (optional but helpful)


Important
The MCP server provides documentation access only. To make actual API calls to ShipStation, you'll need valid API credentials from your ShipStation account.

## Setup Instructions 

Claude Code
Claude Code is Anthropic's official CLI tool with built-in MCP server support.

### Setup Steps

1. Add the ShipStation Documentation MCP server:



```bash
claude mcp add --transport http shipstation-api https://docs.shipstation.com/mcp
```

1. Verify the connection:

```bash
claude
```
Then type `/mcp` to view available tools
2. Start exploring the API:
  - "Show me all available ShipStation endpoints"
  - "Explain how to create a shipment"
  - "What's the schema for the Label resource?"


TIP
Use `/mcp` anytime to view available documentation tools and their current status.

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

### Setup Steps

1. Open the command palette:
  - **macOS**: `Command + Shift + P`
  - **Windows/Linux**: `Ctrl + Shift + P`
2. Select **"Open MCP settings"**
3. Choose **"Add custom MCP"**
4. Configure your `mcp.json` file:



```json
{
  "mcpServers": {
    "shipstation-docs": {
      "url": "https://docs.shipstation.com/mcp"
    }
  }
}
```

1. Save and restart Cursor if prompted
2. Test the connection by asking the AI:
  - "What endpoints are available in the ShipStation API?"
  - "How do I authenticate with ShipStation?"


VS Code
VS Code connects to MCP servers through AI assistant extensions that support MCP.

### Setup Steps

1. Open the command palette:
  - **macOS**: `Command + Shift + P`
  - **Windows/Linux**: `Ctrl + Shift + P`
2. Type **"MCP: Add Server"**
3. Select **"HTTP"** as the connection type
4. Enter the MCP server URL:

```
https://docs.shipstation.com/mcp
```
5. Provide a name for the connection:

```
ShipStation Documentation
```
6. Complete any authentication flow if prompted


## Verification

After connecting, verify the setup works by asking your AI assistant:

**Simple queries:**

- "What API versions does ShipStation offer?"
- "List the main resource types in the ShipStation API"


**Detailed queries:**

- "Show me the request schema for creating a shipment"
- "What are the rate limiting rules?"
- "Explain the difference between shipments and labels"


If you encounter issues:

- Confirm you're using the latest version of your AI tool
- Check that your network allows HTTPS connections to `docs.shipstation.com`
- Restart your AI tool after adding the MCP server


## Use Cases

### For New Developers

"Walk me through creating my first shipment from order to label"

### During Integration

"What fields are required vs optional when creating a label?"

### For Troubleshooting

"I'm getting a 400 error on POST /v2/shipments - what could be wrong?"

### For Discovery

"What capabilities does ShipStation have for inventory management?"

## Next Steps

- **Explore the API** - Use your AI assistant to discover endpoints relevant to your use case
- **Get API Credentials** - Visit your ShipStation account settings to generate API keys
- **Read Guides** - Check out our topic-specific guides for common workflows
- **Test in Postman** - Use the OpenAPI spec to import endpoints into Postman or similar tools


**Learn more:**

- [Getting Started with ShipStation API](/getting-started)
- [Authentication Guide](/authentication)
- [Full API Reference](/apis/openapi)