# read\_docs

Read one docs page, or one section of it by heading, from the docs komrad carries for the running version.

read-only · idempotent · MCP tool · [Docs](https://komrad.dev/latest/api/docs.md)

A link to another docs page gives its path, and a link to the API or CLI reference gives its URL on the docs site. An unknown docs page or heading answers with the closest docs pages or the docs page's headings.

## Calling it

```bash
curl -X POST http://127.0.0.1:8787/komrad.docs.v1.DocsService/ReadDocs \
  -H 'Content-Type: application/json' \
  -d '{
  "page": "<page>"
}'
```

```bash
komrad rpc read-docs \
  --page '<string>'
```

```json
{
  "name": "read_docs",
  "arguments": {
    "page": "<page>"
  }
}
```

Offered by the komrad MCP server to writer, reviewer, orchestrator agents.

## Request

### ReadDocsRequest

| Field | Type | Description |
| --- | --- | --- |
| [`page`](https://komrad.dev/latest/api/docs/read-docs.md#komrad-docs-v1-ReadDocsRequest-page) | string\* | The docs page's path, such as `guides/agents.md` or `config.md`. |
| [`heading`](https://komrad.dev/latest/api/docs/read-docs.md#komrad-docs-v1-ReadDocsRequest-heading) | string | The heading of the one section to read, as its text or its anchor, such as `the-orchestrator`. Empty reads the whole docs page. |

## Response

### ReadDocsResponse

| Field | Type | Description |
| --- | --- | --- |
| [`markdown`](https://komrad.dev/latest/api/docs/read-docs.md#komrad-docs-v1-ReadDocsResponse-markdown) | string | The docs page, or the section under the heading, in markdown. |
