> ## Documentation Index
> Fetch the complete documentation index at: https://docs.allocait.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> What the Allocait connector and Claude Code plugin do, and what they never do

Allocait connects to Claude through a remote MCP server. Once connected, Claude can check your portfolios, and changes to them, against your rules, record what you did, and keep your research.

> [!WARNING]
>
> Allocait never places a trade and never connects to a brokerage. Allocait cannot approve, stop or place an order. It checks the numbers you give it against the rules you wrote. Values and verdicts use prices you or Claude supply. Allocait returns no price.

If you connect by signing in, the portfolio snapshot also carries `standing`, which has no price. See [Standing](https://docs.allocait.app/concepts/standing.md).

## What Claude can do

* **Check compliance.** Compare a portfolio, or a proposed set of allocations, against your rules.
* **Work out the amounts.** See the pro rata amounts that close the gap to your bands, at prices you supply. Allocait places nothing.
* **Check a change.** `check_trades` reports which of your rules a change puts outside range or leaves further outside. It writes nothing and decides nothing. See [Check a change](https://docs.allocait.app/guides/check-before-you-trade.md).
* **Record what already happened.** Update Allocait's record of a holding or your cash after a trade or deposit you made elsewhere.
* **Write and change rules.** Change one class's band, or draft rules text, preview what it would change, and apply it. `apply_rules` and `save_class_rule` return a restore point that `restore_rules` can put back. Deleting a scenario can't be undone.
* **Keep your research.** Watchlists, playbooks, inputs, monitors and charts.
* **Read where you stand.** Ask for a short brief, and for later ones to list only what changed. Allocait runs no schedule and sends no alerts. See [Scheduled brief](https://docs.allocait.app/guides/scheduled-brief.md).
* **Add a shared setup.** Preview a setup file someone wrote, and add it only after you say yes. See [ALLOCAIT.md](https://docs.allocait.app/concepts/setup-file.md).
* **Review and comment on your actions.** Read past trades and cash movements, and record why you made each decision.

## Read tools and write tools

Every tool is one or the other.

| | Read tools | Write tools |
| - | - | - |
| Effect | Never change anything in your account | Change data in Allocait: a holding, a rule, a cash entry, a watchlist |
| Returns | A snapshot, a validation result or a list | The saved record |
| Access needed | **Read only** or **Read and change** | **Read and change** |

A write marked destructive can overwrite or remove data. Deleting a portfolio removes everything in it, and deleting a portfolio or a scenario can't be undone. Both need `confirm_name`, passed exactly as you confirmed it.

**Read only** also allows `send_feedback` with `topic: tools` or `topic: early_access`. See [Access levels](https://docs.allocait.app/concepts/access-levels.md) for what each level allows, and [All tools](https://docs.allocait.app/claude/tools.md) for every tool grouped by feature.

## What a tool call looks like

An MCP client sends a JSON-RPC `tools/call` request like this one. It asks `check_trades` whether a 40-share change to `ALFA` puts any rule outside range, at prices the caller supplies.

Illustrative example. The figures are hypothetical, not a recommendation.

```json theme={null}
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "check_trades",
    "arguments": {
      "portfolio_id": "919bbfb9-c2e7-4c4c-9d6d-d20f83330245",
      "trades": [ { "symbol": "ALFA", "side": "BUY", "shares": 40 } ],
      "prices": { "ALFA": 181.5, "BRAV": 94.2, "GOLF": 62.3 }
    }
  }
}
```

The result carries the data twice: as `structuredContent` for code, and as the same JSON in a text block for clients that read text. A refusal comes back as an [error](https://docs.allocait.app/claude/errors.md) with `error_code` in its structured fields. For the fields of a check result, see [Check result](https://docs.allocait.app/concepts/check-result.md).

## What Allocait is not

Allocait checks your holdings against rules you wrote. It does not give investment advice or recommend trades. Allocait cannot approve, stop or place an order. Every result is a mechanical comparison against the rules you configured.

## Next steps

> [card] [Install plugin](https://docs.allocait.app/claude/install-plugin.md)
>
> Add the Allocait plugin in Claude Code.

> [card] [Connect Claude](https://docs.allocait.app/claude/connect.md)
>
> Sign in through the connector.

> [card] [All tools](https://docs.allocait.app/claude/tools.md)
>
> Every MCP tool, grouped by feature.

> [card] [Read prompts](https://docs.allocait.app/claude/example-prompts.md)
>
> Realistic prompts and the tools they use.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.