> 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`. Claude (web, desktop and mobile) signs in with your PaintScout login. Other clients use 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.**

<details>

<summary>Connection instructions and available tools</summary>

#### Claude (claude.ai, Claude Desktop, Claude mobile)

1. Open Settings > Connectors > Add custom connector (menu names may vary by app version).
2. Enter `https://mcp.paintscout.com/mcp` as the URL.
3. Open Advanced settings and enter this OAuth Client ID: `w2VJstiPPuRZqw3M1ylqVwfivvCPUfS3`. Leave the Client Secret empty. This Client ID is public on purpose: it is not a secret, and it grants nothing until you sign in.
4. Click Add, then Connect, and sign in with your PaintScout email and password.

The connector acts as the PaintScout user who signed in. It needs no API Key.

#### 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"
      }
    }
  }
}
```

#### 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`                                             |
| Activities                 | `listActivities`                                                   |
| 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`                                       |

</details>


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.