> For the complete documentation index, see [llms.txt](https://help.paintscout.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.paintscout.com/developers/connecting-an-mcp-client.md).

# Connecting an MCP client

Alongside this REST API, PaintScout hosts a read-only MCP (Model Context Protocol) server at `https://mcp.paintscout.com/mcp`. It lets AI assistants and agents query your PaintScout data directly, using the same API Key as the REST API above.

**Write operations (create, update, delete) are only available through the REST API described below. The MCP server exposes read-only tools only — it cannot create, update, or delete anything.**

#### Claude Code

```
claude mcp add --transport http paintscout https://mcp.paintscout.com/mcp --header "Authorization: Bearer YOUR_API_KEY"
```

#### Cursor

Add to `.cursor/mcp.json`:

```json
{
  "mcpServers": {
    "paintscout": {
      "url": "https://mcp.paintscout.com/mcp",
      "headers": {
        "Authorization": "Bearer YOUR_API_KEY"
      }
    }
  }
}
```

#### Claude Desktop

Settings > Connectors > Add custom connector (menu names may vary by app version). Enter `https://mcp.paintscout.com/mcp` as the URL, then add a custom header: `Authorization: Bearer YOUR_API_KEY`.

#### Available tools

Every tool is a read (GET) operation — one `list*` and one `get*` tool per resource, grouped below by resource:

| Resource                   | Tools                                                              |
| -------------------------- | ------------------------------------------------------------------ |
| Companies                  | `listCompanies`, `getCompany`                                      |
| Contacts                   | `listContacts`, `getContact`                                       |
| Deals                      | `listDeals`, `getDeal`                                             |
| Events                     | `listEvents`, `getEvent`                                           |
| Quotes                     | `listQuotes`, `getQuote`, `listQuoteItems`, `getQuoteItem`         |
| Invoices                   | `listInvoices`, `getInvoice`, `listInvoiceItems`, `getInvoiceItem` |
| Notes                      | `listNotes`, `getNote`                                             |
| Tasks                      | `listTasks`, `getTask`                                             |
| Users                      | `listUsers`, `getUser`                                             |
| Webhooks                   | `listWebhooks`, `getWebhook`                                       |
| Settings - Area Labels     | `listAreaLabels`, `getAreaLabel`                                   |
| Settings - Event Types     | `listEventTypes`, `getEventType`                                   |
| Settings - Labels          | `getObjectLabels`                                                  |
| Settings - Lead Sources    | `listLeadSources`, `getLeadSource`                                 |
| Settings - Line Items      | `listLineItemOptions`, `getLineItem`                               |
| Settings - Pipelines       | `listPipelines`, `getPipeline`                                     |
| Settings - Stages          | `listStages`, `getPipelineStages`                                  |
| Settings - Products        | `listProducts`, `getProduct`                                       |
| Settings - Quote Templates | `listQuoteTemplates`, `getQuoteTemplate`                           |
| Settings - Quote Types     | `listQuoteTypes`, `getQuoteType`                                   |
| Settings - Rate Categories | `listRateCategories`, `getRateCategory`                            |
| Settings - Rates           | `listRates`, `getRate`                                             |
| Settings - Tags            | `listTags`, `getTag`                                               |
| Settings - Tax Rates       | `listTaxRates`, `getTaxRate`                                       |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://help.paintscout.com/developers/connecting-an-mcp-client.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.