akb_put
Store a new document in a vault or collection and get its canonical akb:// URI. Content is automatically chunked and indexed for semantic search.
Instructions
Store a new document. The response carries the canonical uri — akb://{vault}/coll/{collection}/doc/{filename} when stored under a collection, or akb://{vault}/doc/{filename} at the vault root. Use that URI to address the document from every other tool. Automatically chunked and indexed for semantic search.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| file | No | Local file path to read as document body (alternative to content). Provide either file or content, not both. | |
| slug | No | Optional explicit slug for the document filename. When stored under a collection the URI is `akb://{vault}/coll/{collection}/doc/{slug}.md`; at the vault root it is `akb://{vault}/doc/{slug}.md`. When omitted, the slug is derived from the title. Pass it to keep the path stable and meaningful when the title is friendly, changeable text (e.g. slug `github-issue-123` with a human-readable title). | |
| tags | No | Tags for classification | |
| type | No | Document type. Free-form — any string is accepted, EXCEPT 'skill', which is reserved for the system-managed vault-skill document. Recommended vocabulary: note (default), report, decision, spec, plan, session, task, reference. Use a custom value when none fit (e.g. an OKF concept type). | note |
| title | Yes | Document title | |
| vault | No | Target vault name. Required unless `parent` is given. | |
| domain | No | Domain: engineering, product, ops, legal, etc. | |
| parent | No | Parent location as a canonical URI — `akb://{vault}` for the vault root, `akb://{vault}/coll/{path}` for a collection. When given, the doc is placed there and `vault`/`collection` are derived from the URI. Use this in drill-down chains: paste the `uri` from an `akb_browse` response straight back in. | |
| status | No | Lifecycle status. Defaults to 'draft'; pass 'active' to publish on create instead of promoting later with akb_update. Descriptive metadata only — it does not gate search, browse, or access. | draft |
| content | Yes | Document body in Markdown | |
| summary | No | Brief summary (auto-generated if omitted) | |
| collection | No | Collection (directory) path, e.g. 'api-specs' or 'meeting-notes'. Ignored when `parent` is given. 'overview' is a reserved system collection (vault-skill only). | |
| depends_on | No | Same-vault akb:// URIs this depends on. Use an ordinary Markdown link for a cross-vault reference. | |
| related_to | No | Same-vault akb:// URIs of related resources. Use an ordinary Markdown link for a cross-vault reference. | |
| _vault_skill_ack | No | Opaque acknowledgement returned as vault_skill.ack_token. After applying that guide, retry the unchanged operation with this value. The bundled proxy supplies it automatically. |