> For the complete documentation index, see [llms.txt](https://docs.scaleconnect.com.au/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.scaleconnect.com.au/api/mcp/scaleconnect-mcp.md).

# ScaleConnect MCP

{% @scale-docs-page-title/page-title title="ScaleConnect MCP" %}

{% hint style="warning" %}
**Confirm before publishing:** server URL and transport, broker versus integrator credentials, exact generated tool names, operation allowlist, granted scopes, client-book isolation, rate limits and write approvals. The table maps the proposed public REST contract; it is not a list of tools available from a live product MCP server.
{% endhint %}

ScaleConnect MCP gives an authorized broker or integration structured access to the brokerage book. Every tool calls the corresponding versioned REST operation under the **same identity and scopes**.

## Tool map

| Tool               | REST operation                                 | Access                              |
| ------------------ | ---------------------------------------------- | ----------------------------------- |
| `get_client`       | `GET /v1/integrators/clients/{id}`             | `clients:read` and client reach     |
| `get_portfolio`    | `GET /v1/integrators/clients/{id}/portfolio`   | `portfolio:read`                    |
| `get_timeline`     | `GET /v1/integrators/clients/{id}/timeline`    | `portfolio:read`                    |
| `get_actuals`      | `GET /v1/integrators/clients/{id}/actuals`     | `actuals:read`                      |
| `get_loans`        | `GET /v1/integrators/clients/{id}/loans`       | `loans:read`                        |
| `get_book`         | `GET /v1/integrators/book` and `/book/clients` | `broker:read`                       |
| `sync_client`      | `POST /v1/integrators/sync/client`             | `sync:write`                        |
| `sync_property`    | `POST /v1/integrators/sync/property`           | `sync:write`                        |
| Webhook management | Subscription, delivery and rotation routes     | `webhooks:read` or `webhooks:write` |

A tool without the required scope should not appear in discovery for that connection. The REST service must still check the scope and client reach on each call; hiding a tool is not an authorization control.

## Example workflow

A broker asks, “Show the clients in my book whose fixed rates are coming up.” The MCP client calls an approved book read, then a permitted loan read for each selected client. The server returns only clients inside that broker's current reach. The client may draft an action, but it should not create a note or message without the relevant write tool and explicit user approval.

## Operational rules

* Use the public OpenAPI selection as the source for tool descriptions and schemas.
* Preserve REST status and error meaning in tool results.
* Audit the caller, tool, backing route, resource and outcome.
* Apply the same per-integrator rate limit as REST.
* Treat bulk sync as an asynchronous write; return its import ID and follow status rather than claiming immediate completion.

See [Authentication](/api/authentication.md) and [ScaleConnect REST API](/api/rest-api/scaleconnect-rest-api.md) for the underlying contract.


---

# 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://docs.scaleconnect.com.au/api/mcp/scaleconnect-mcp.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.