# Brief (`mttr_brief`)

Updated October 24, 2026.

## What does mttr_brief do?

The fix list for a site as Markdown, written to be acted on: what to fix, in what order, how, why, and on which pages. Start here. Any key may make this call, on any public site.

Who may call it: Any key.

## When to use it

- You hand a site to an assistant to fix.
- You want the whole list in one piece of text.

## What you ask

You might say: “Get the mttr brief for example.com and work through it.”

```
mttr_brief({ site: "example.com" })
```

| Argument | Type | Needed | What it is |
| --- | --- | --- | --- |
| `site` | Text | Yes | The site, as a domain such as example.com. |

## What comes back

- How the site stands, stage by stage.
- Each fix in order, with what to do, why, and its pages.
- Verdicts that wait for a person, set apart.

A sample, with made-up sites and figures:

```
# Fix list for example.com

mttr read 100 pages of https://example.com and scored them 72 of 100.

A score says pages are well formed. It does not say an assistant cites the site.

## 1. Show sources on guides

- **Rule:** `sources-shown`, stage trust, weight 4 of 5
- **Failing:** 12 pages
- **What to do:** Link the sources for the guide’s facts where a reader can see them.
- **Pages:**
  - `/guides/drain-cleaning`
  - `/guides/septic-care`
  - and 10 more
```

## Over HTTP

```
curl "https://mttr.si/api/v1/sites/example.com/brief" \
  -H "Authorization: Bearer $MTTR_KEY"
```

## When it fails

| When | Status | What to do |
| --- | --- | --- |
| Your assistant has no key yet | 401 over MCP | Sign up with `mttr_signup`, then connect again with the key it gives. |
| mttr has no public report of the site yet | 404 | Ask for a read with `mttr_rescan`, then watch it with `mttr_job`. |

## Sources

- [Model Context Protocol: tools](https://modelcontextprotocol.io/specification/2025-06-18/server/tools), Model Context Protocol: How an assistant calls a tool.

The call in full: [mttr_brief in the API reference](https://mttr.si/docs/reference#mttr_brief).

## Goes with

- [Plan](https://mttr.si/docs/tools/plan.md)
- [Read it again](https://mttr.si/docs/tools/rescan.md)