> 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/scaleapp-mcp.md).

# ScaleApp MCP

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

{% hint style="warning" %}
**Confirm before publishing:** the ScaleApp MCP server URL, transport, delegated sign-in and consent, selected public API operations, exact tool names and schemas, household access, write approvals and availability. No customer-facing ScaleApp MCP server has been verified.
{% endhint %}

ScaleApp MCP is for a person connecting an AI client to **their own** ScaleApp data. The server should expose the same account and household reach as the signed-in product, with no access to another customer's data.

## Connect

1. In a supported MCP client, add the ScaleApp server URL.
2. Sign in through the approved delegated flow.
3. Review the account and scopes shown on the consent screen.
4. Start with a read such as profile or strategy lookup.
5. Approve a write only after checking the client, strategy and proposed change.

A client should display when its connection expires or is revoked and provide a disconnect control. The server must not ask for a product password or a copied browser token.

## Tool families

| Family              | Examples of permitted use                       | Access               |
| ------------------- | ----------------------------------------------- | -------------------- |
| Account             | Read the signed-in profile and preferences      | Own account          |
| Household           | Read family and entity relationships            | Household membership |
| Portfolio           | Read properties, loans and calculated summaries | Permitted strategies |
| Simulator           | Compare saved scenarios and outputs             | Permitted strategies |
| Tasks and documents | Read or create user-owned records               | Explicit write grant |

The final tool catalogue will give every tool a stable name, input JSON Schema, result schema, error cases and backing versioned REST operation. Calculated figures must come from the calculation service, not a raw database field with a similar name.

## Data and approvals

A tool call is audited with the connected user and resource. Read results should include enough provenance to distinguish stored inputs from derived outputs. For writes, require explicit confirmation in the MCP client and return the changed resource or a request ID. Revoking access must prevent further calls immediately, even if the MCP client has cached its tool list.


---

# 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/scaleapp-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.