MCP tools - Knowledge-MCP

The server serves MCP over stdio and opens no network port. Harnesses with a knowledge-mcp plugin start the server through the plugin. Other harnesses run kb mcp.

Generated regions come from tools.json, the tools/list response. After a tool change, run just generate_contract_snapshots, then just generate_mcp_tools_doc.

File access and side effects

The agent supplies document text, inventories and configuration, then applies prepared file changes with its own tools. Preparation tools return text for the agent to save; tool calls also append answers to the state log. kb_record_edit stores edit history there, and kbp_explore writes offline viewers. See data handling and retention. The included writing skill and tracking skill cover approval, link searches, configuration checks, applying changes and guarded undo. The naming and filing guide explains the workflow for readers.

Tools

Tool	Purpose	Result
`kb_get_document_type`	Get a file’s document type and proposed name and folder from saved entries, conventions and the complete listing.	document-type.schema.yaml
`kb_list_audiences`	List the readers you can choose for a document type.	audiences.schema.yaml
`kb_list_convention_templates`	List bundled ACE, PARA and Johnny.Decimal definitions for notes, with folder purposes, naming suggestions and sources.	convention-templates.schema.yaml
`kb_list_conventions`	List naming and filing conventions that apply in a folder, with their source folders and parent marks.	folder-conventions.schema.yaml
`kb_list_edits`	List the edits recorded for `location`, oldest first, to check or undo an edit or to pick up earlier work.	edits.schema.yaml
`kb_prepare_conventions`	Prepare conventions text from supplied configuration and proposed changes.	conventions-update.schema.yaml
`kb_prepare_document_move`	Prepare a document move from supplied text, a complete listing and permission.	document-move.schema.yaml
`kb_prepare_document_moves`	Prepare moves together from supplied text and a complete listing.	document-moves.schema.yaml
`kb_prepare_document_types`	Prepare document-types text by comparing a complete listing with saved entries.	document-types-update.schema.yaml
`kb_prepare_import`	Prepare an import by splitting `text` into passages and listing questions for document types in the destination `folders`.	import.schema.yaml
`kb_prepare_proposal`	Prepare the proposed-changes card whenever you propose changes to a document, before any edit.	proposal.schema.yaml
`kb_record_edit`	Record an edit right after you make it, so the person can check or undo the change.	edit.schema.yaml
`kbp_card`	Read the card for a document type before you draft or edit a document of that type.	kbp-output.schema.yaml
`kbp_explore`	Write an offline HTML viewer for a universe spec under `explorer/` beside `log.jsonl`.	kbp-output.schema.yaml
`kbp_inspect`	Get a universe spec and its type guidance as kbp’s JSON model.	kbp-output.schema.yaml
`kbp_kinds`	List the document types of the universe specs that apply.	kbp-output.schema.yaml
`kbp_mint`	Mint new `code` values of one `kind` for universe spec entries.	kbp-output.schema.yaml
`kbp_self_check`	Validate kbp’s bundled protocol definition with `kbp --self-check`.	kbp-output.schema.yaml
`kbp_validate`	Validate files in the nearest supplied `.knowledge-bus/` folder and parent files named in its `workspace.yaml`, using file text or digests from this session.	kbp-output.schema.yaml
`kbp_version`	Get the installed knowledge-bus release and protocol version from `kbp --version`.	kbp-output.schema.yaml

When kbp runs, the result contains one text block per non-empty stream, with stdout before stderr. Each block identifies the stream in _meta.stream. Tools with a folders argument can append a JSON text block with _meta.stream set to knowledge-mcp. That block lists bundled or received universe specs and, after a successful kbp_explore call, the explorer folder. The result contains the kbp exit code in _meta.exit_code and sets isError for a non-zero exit code. kb_prepare_proposal, kb_record_edit and kb_list_edits also return a Markdown card in card, repeated as the first text block, for harnesses that pass only one of the two to the model. Failures in kb_* tools and errors before kbp runs return a problem object in structuredContent. problem.schema.yaml lists the problem types.

Arguments

`kb_get_document_type`

Argument	Type	Required	Meaning
`location`	string	yes	A knowledge-base or document location as plain text. knowledge-mcp logs this text and never opens the location.
`name`	string	yes
`folders`	list of string	yes	Folder names from the knowledge-base root down to the folder whose universe specs apply, such as `["docs", "rfcs"]`. Empty for the root folder.
`knowledge_bus_folders`	list of KnowledgeBusFolder	yes	Every folder containing .knowledge-bus/, including peer folders. Include empty configuration folders. Classification uses the ancestors of the subject document; filing compares peers under the applicable universe specs.
`role`	string or null	no	The reader’s role, such as maintainer. Put document types for that role first.
`record`	string or null	no	The unedited text of `.knowledge-bus/plugins/knowledge-mcp/document-types.yaml` under the knowledge base root folder. When that file is missing, send the text of `.knowledge-bus/plugins/knowledge-mcp/record.yaml`, which knowledge-mcp 0.2.1 and earlier used. Send an empty string when both files are missing.
`record_digest`	Digest or null	no	Send the document-types digest from an earlier result in this session in place of `record` while the file remains unchanged.
`changes`	list of FileChange or null	no	Files changed since the document-types file was last saved. Send them with `record` or `record_digest`. knowledge-mcp applies the changes to the entries for this answer only.
`listing`	list of ListedFile or null	no
`conventions`	string or null	no	Current target conventions file text. Send empty text when the file is absent.
`conventions_digest`	string or null	no	Conventions digest received in this session. Reuse while the file remains unchanged.
`filing_values`	list of FilingValue or null	no
`conventions_files`	list of ConventionFile or null	no

`kb_list_audiences`

Argument	Type	Required	Meaning
`location`	string	yes	A knowledge-base or document location as plain text. knowledge-mcp logs this text and never opens the location.
`folders`	list of string	yes	Folder names from the knowledge-base root down to the folder whose universe specs apply, such as `["docs", "rfcs"]`. Empty for the root folder.
`knowledge_bus_folders`	list of KnowledgeBusFolder	yes	One entry per folder that holds a `.knowledge-bus/` folder, from the root folder down to the target folder. Include `.knowledge-bus/` folders with no `.kbp.yaml` file. If no entry has a `.kbp.yaml` file or `workspace.yaml`, tools use the bundled universe specs. kbp_validate returns an error instead.
`document_type`	string	yes	A document type id, such as `design-doc`.
`universe_spec`	string or null	no	Id of the universe spec to use when the document type appears in more than one universe spec that applies.

`kb_list_convention_templates`

Argument	Type	Required	Meaning
`location`	string	yes	A knowledge-base or document location as plain text. knowledge-mcp logs this text and never opens the location.

`kb_list_conventions`

Argument	Type	Required	Meaning
`location`	string	yes	A knowledge-base or document location as plain text. knowledge-mcp logs this text and never opens the location.
`folder`	string	yes
`knowledge_bus_folders`	list of KnowledgeBusFolder	yes
`conventions_files`	list of ConventionFile	yes

`kb_list_edits`

Argument	Type	Required	Meaning
`location`	string	yes	A knowledge-base or document location as plain text. knowledge-mcp logs this text and never opens the location.

`kb_prepare_conventions`

Argument	Type	Required	Meaning
`location`	string	yes	A knowledge-base or document location as plain text. knowledge-mcp logs this text and never opens the location.
`conventions`	string or null	no	Current target conventions file text. Send empty text when the file is absent.
`conventions_digest`	string or null	no	Conventions digest received in this session. Reuse while the file remains unchanged.
`knowledge_bus_folders`	list of KnowledgeBusFolder	no
`changes`	list of Change	no
`allowed_by`	AllowedBy or null	no
`folder`	string	no
`conventions_files`	list of ConventionFile or null	no
`from_parent`	list of ConventionReference or null	no

`kb_prepare_document_move`

Argument	Type	Required	Meaning
`location`	string	yes
`old_path`	MovePath	yes
`path`	MovePath	yes
`listing`	list of ListedFile	yes
`documents`	list of MoveDocument	yes
`case_mode`	`sensitive` or `insensitive`	yes
`allowed_by`	AllowedBy	yes
`knowledge_bus_folders`	list of KnowledgeBusFolder	yes
`record`	string or null	no	The unedited text of `.knowledge-bus/plugins/knowledge-mcp/document-types.yaml` under the knowledge base root folder. When that file is missing, send the text of `.knowledge-bus/plugins/knowledge-mcp/record.yaml`, which knowledge-mcp 0.2.1 and earlier used. Send an empty string when both files are missing.
`record_digest`	Digest or null	no	Send the document-types digest from an earlier result in this session in place of `record` while the file remains unchanged.
`searched`	boolean	no
`search`	list of string or null	no
`bindings`	list of LinkBinding or null	no

`kb_prepare_document_moves`

Argument	Type	Required	Meaning
`location`	string	yes
`moves`	list of DocumentMove	yes
`listing`	list of ListedFile	yes
`documents`	list of MoveDocument	yes
`case_mode`	`sensitive` or `insensitive`	yes
`knowledge_bus_folders`	list of KnowledgeBusFolder	yes
`record`	string or null	no	The unedited text of `.knowledge-bus/plugins/knowledge-mcp/document-types.yaml` under the knowledge base root folder. When that file is missing, send the text of `.knowledge-bus/plugins/knowledge-mcp/record.yaml`, which knowledge-mcp 0.2.1 and earlier used. Send an empty string when both files are missing.
`record_digest`	Digest or null	no	Send the document-types digest from an earlier result in this session in place of `record` while the file remains unchanged.
`allowed_by`	AllowedBy or null	no
`searched`	boolean	no
`search`	list of string or null	no
`bindings`	list of LinkBinding or null	no

`kb_prepare_document_types`

Argument	Type	Required	Meaning
`location`	string	yes	The knowledge base root folder as plain text, such as a local path, a Drive folder link or a Notion page. knowledge-mcp logs this text and never opens the location.
`record`	string or null	no	The unedited text of `.knowledge-bus/plugins/knowledge-mcp/document-types.yaml` under the knowledge base root folder. When that file is missing, send the text of `.knowledge-bus/plugins/knowledge-mcp/record.yaml`, which knowledge-mcp 0.2.1 and earlier used. Send an empty string when both files are missing.
`record_digest`	Digest or null	no	Send the document-types digest from an earlier result in this session in place of `record` while the file remains unchanged.
`knowledge_bus_folders`	list of KnowledgeBusFolder	no	Every knowledge base folder that holds a `.knowledge-bus/` folder, even one with no `.kbp.yaml` file. The bundled universe specs apply to a file when no `.knowledge-bus/` folder between the root and the file holds a `.kbp.yaml` file or `workspace.yaml`.
`listing`	list of ListedFile or null	no	Every knowledge-base file, including attachments and files in nested folders. Exclude files beneath every `.knowledge-bus/` folder. Send the listing after complete enumeration; an incomplete listing can produce false deletion claims.
`changes`	list of FileChange or null	no	Files changed since the document-types file was last saved.
`entries`	list of EntryItem or null	no	Send your document type choices and any document types or readers specified by the person.
`recheck`	boolean or null	no	True to put every file with an entry back in `to_settle`, except files with a `set_by: person` entry.
`allowed_by`	AllowedBy or null	no
`conventions`	string or null	no	Current target conventions file text. Send empty text when the file is absent.
`conventions_digest`	string or null	no	Conventions digest received in this session. Reuse while the file remains unchanged.
`filing_values`	list of FilingValue or null	no
`conventions_files`	list of ConventionFile or null	no
`filing_review`	FilingReview or null	no

`kb_prepare_import`

Argument	Type	Required	Meaning
`location`	string	yes	The source document’s location as plain text, such as a local path, a Drive link, a Notion page or `pasted in chat`. knowledge-mcp logs this text and never opens the location.
`text`	string	yes	The document’s text, as read from its source or pasted by the person.
`folders`	list of string	yes	Folder names from the knowledge base root folder down to the destination folder. Empty for the root folder or when the person named no folder.
`knowledge_bus_folders`	list of KnowledgeBusFolder	yes	One entry per folder that holds a `.knowledge-bus/` folder, from the root folder down to the target folder. Include `.knowledge-bus/` folders with no `.kbp.yaml` file. If no entry has a `.kbp.yaml` file or `workspace.yaml`, tools use the bundled universe specs. kbp_validate returns an error instead.

`kb_prepare_proposal`

Argument	Type	Required	Meaning
`location`	string	yes	A knowledge-base or document location as plain text. knowledge-mcp logs this text and never opens the location.
`summary`	string	yes	What the proposal changes, in one line.
`rows`	list of ProposalRow	yes	One row per change, in display order. The card names row n change Cn.
`left_out`	list of LeftOutFile or null	no	Files you read but didn’t cite.
`layout`	Layout	no	`list` in a terminal, which can’t scroll a wide table sideways.

`kb_record_edit`

Argument	Type	Required	Meaning
`location`	string	yes	A knowledge-base or document location as plain text. knowledge-mcp logs this text and never opens the location.
`allowed_by`	AllowedBy	yes
`before`	string	yes	The replaced text. Send an empty string for a new file.
`after`	string or null	no	The text that replaced `before`. Omit it only for a whole-file edit sent with `after_digest`.
`after_digest`	string or null	no	The SHA-256 of `after` as UTF-8, written `sha256:` plus 64 lowercase hex digits. Replaces `after` only when `whole_file` is true.
`whole_file`	boolean or null	no	True when `before` is the whole file.
`operation`	EditOperation or null	no

`kbp_card`

Argument	Type	Required	Meaning
`location`	string	yes	A knowledge-base or document location as plain text. knowledge-mcp logs this text and never opens the location.
`folders`	list of string	yes	Folder names from the knowledge-base root down to the folder whose universe specs apply, such as `["docs", "rfcs"]`. Empty for the root folder.
`knowledge_bus_folders`	list of KnowledgeBusFolder	yes	One entry per folder that holds a `.knowledge-bus/` folder, from the root folder down to the target folder. Include `.knowledge-bus/` folders with no `.kbp.yaml` file. If no entry has a `.kbp.yaml` file or `workspace.yaml`, tools use the bundled universe specs. kbp_validate returns an error instead.
`kind`	string	yes	The document type id, such as `design-doc`.
`universe`	string or null	no	Id of the universe spec to use when several universe specs apply.
`format`	`json` or `markdown` or null	no	Defaults to `markdown`.

`kbp_explore`

Argument	Type	Required	Meaning
`location`	string	yes	A knowledge-base or document location as plain text. knowledge-mcp logs this text and never opens the location.
`folders`	list of string	yes	Folder names from the knowledge-base root down to the folder whose universe specs apply, such as `["docs", "rfcs"]`. Empty for the root folder.
`knowledge_bus_folders`	list of KnowledgeBusFolder	yes	One entry per folder that holds a `.knowledge-bus/` folder, from the root folder down to the target folder. Include `.knowledge-bus/` folders with no `.kbp.yaml` file. If no entry has a `.kbp.yaml` file or `workspace.yaml`, tools use the bundled universe specs. kbp_validate returns an error instead.
`universe`	string or null	no	Id of the universe spec to use when several universe specs apply.

`kbp_inspect`

Argument	Type	Required	Meaning
`location`	string	yes	A knowledge-base or document location as plain text. knowledge-mcp logs this text and never opens the location.
`folders`	list of string	yes	Folder names from the knowledge-base root down to the folder whose universe specs apply, such as `["docs", "rfcs"]`. Empty for the root folder.
`knowledge_bus_folders`	list of KnowledgeBusFolder	yes	One entry per folder that holds a `.knowledge-bus/` folder, from the root folder down to the target folder. Include `.knowledge-bus/` folders with no `.kbp.yaml` file. If no entry has a `.kbp.yaml` file or `workspace.yaml`, tools use the bundled universe specs. kbp_validate returns an error instead.
`universe`	string or null	no	Id of the universe spec to use when several universe specs apply.

`kbp_kinds`

Argument	Type	Required	Meaning
`location`	string	yes	A knowledge-base or document location as plain text. knowledge-mcp logs this text and never opens the location.
`folders`	list of string	yes	Folder names from the knowledge-base root down to the folder whose universe specs apply, such as `["docs", "rfcs"]`. Empty for the root folder.
`knowledge_bus_folders`	list of KnowledgeBusFolder	yes	One entry per folder that holds a `.knowledge-bus/` folder, from the root folder down to the target folder. Include `.knowledge-bus/` folders with no `.kbp.yaml` file. If no entry has a `.kbp.yaml` file or `workspace.yaml`, tools use the bundled universe specs. kbp_validate returns an error instead.
`universe`	string or null	no	Id of the universe spec to use when several universe specs apply.
`format`	`json` or `markdown` or null	no	Defaults to `json`.

`kbp_mint`

Argument	Type	Required	Meaning
`location`	string	yes	A knowledge-base or document location as plain text. knowledge-mcp logs this text and never opens the location.
`folders`	list of string	yes	Folder names from the knowledge-base root down to the folder whose universe specs apply, such as `["docs", "rfcs"]`. Empty for the root folder.
`knowledge_bus_folders`	list of KnowledgeBusFolder	yes	One entry per folder that holds a `.knowledge-bus/` folder, from the root folder down to the target folder. Include `.knowledge-bus/` folders with no `.kbp.yaml` file. If no entry has a `.kbp.yaml` file or `workspace.yaml`, tools use the bundled universe specs. kbp_validate returns an error instead.
`kind`	`element`, `artifact`, `frame` or `factor`	yes
`count`	integer or null	no	Number of codes to mint, one by default.

`kbp_self_check`

No arguments.

`kbp_validate`

Argument	Type	Required	Meaning
`location`	string	yes	A knowledge-base or document location as plain text. knowledge-mcp logs this text and never opens the location.
`folders`	list of string	yes	Folder names from the knowledge-base root down to the folder whose universe specs apply, such as `["docs", "rfcs"]`. Empty for the root folder.
`knowledge_bus_folders`	list of KnowledgeBusFolder	yes	One entry per folder that holds a `.knowledge-bus/` folder, from the root folder down to the target folder. Include `.knowledge-bus/` folders with no `.kbp.yaml` file. If no entry has a `.kbp.yaml` file or `workspace.yaml`, tools use the bundled universe specs. kbp_validate returns an error instead.

`kbp_version`

No arguments.

Shapes

AllowedBy

The person’s permission for the save or the edit.

Field	Type	Required	Meaning
`basis`	`request`, `instruction` or `accepted_change`	yes	`request` means the person asked in this session. `instruction` means the person wrote an instruction for agents, such as in AGENTS.md. `accepted_change` means the person accepted a proposed change.
`text`	string	yes	The request, instruction or accepted change, quoted.
`location`	string or null	no	The file holding the instruction or the accepted change.

Audience

The document’s reader, and whether the person confirmed the value.

Field	Type	Required	Meaning
`value`	string	yes
`status`	`confirmed` or `guessed`	yes

Change

Type: UpsertConvention or RemoveConvention.

ConventionContent

Field	Type	Required	Meaning
`label`	string	yes
`instruction`	string	yes

ConventionContentPart

Field	Type	Required	Meaning
`part`	`content`	yes

ConventionDatePart

Field	Type	Required
`part`	`date`	yes
`property`	string	yes
`format`	`YYYY-MM-DD`, `YYYY-MM` or `YYYY`	yes

ConventionDocumentTypePart

Field	Type	Required	Meaning
`part`	`document_type`	yes

ConventionFile

Type: ConventionFile1 or ConventionFile2.

ConventionFile1

Field	Type	Required	Meaning
`folder`	ConventionsFolder	yes	The declaring folder relative to the knowledge-base root; empty for the root.
`text`	string	yes	Complete conventions text, or an empty string to report an absent file.
`digest`	Digest or null	no	A digest from this session, in place of unchanged conventions text.

ConventionFile2

Field	Type	Required	Meaning
`folder`	ConventionsFolder	yes	The declaring folder relative to the knowledge-base root; empty for the root.
`text`	string or null	no	Complete conventions text, or an empty string to report an absent file.
`digest`	Digest	yes	A digest from this session, in place of unchanged conventions text.

ConventionLiteralPart

Field	Type	Required	Meaning
`part`	`literal`	yes
`value`	ConventionSegment	yes

ConventionName

Field	Type	Required
`separator`	, `-` or `_`	yes
`case`	`as-written` or `lower` or null	no
`parts`	list of Part	yes

ConventionPropertyPart

Field	Type	Required	Meaning
`part`	`property`	yes
`property`	string	yes

ConventionReference

Field	Type	Required	Meaning
`universe_spec`	string	yes
`document_type`	string	yes

ConventionSegment

Type: string, pattern ^[^#|^:/\\\[\]\u0000-\u001f\u007f-\u009f]+$.

ConventionsFolder

Type: string, pattern ^(?:[^/\\\u0000]+(?:/[^/\\\u0000]+)*)?$.

Digest

The SHA-256 of the text’s UTF-8 bytes. Type: string, pattern ^sha256:[0-9a-f]{64}$.

DocumentMove

Field	Type	Required	Meaning
`old_path`	MovePath	yes
`path`	MovePath	yes

EditOperation

Field	Type	Required	Meaning
`id`	string	yes	An opaque id shared by every edit in the same operation.
`index`	integer	yes	The edit’s unique one-based position within the operation.
`count`	integer	yes	Total edits in the operation, including referring documents and the document-types file.
`old_path`	Path	yes	Original path; equal to `path` for a stationary referring document.
`path`	Path	yes	Final path after the operation.

EntryItem

Field	Type	Required	Meaning
`path`	string	yes	Path from the knowledge-base root, folders joined by `/`, such as `docs/rfcs/0042-cache.md`.
`set_by`	SetBy	yes	`agent` when you chose the document type or reader. `person` when the person stated the document type or reader.
`universe_spec`	string or null	no	Id of the universe spec that declares `document_type`.
`document_type`	string or null	no
`no_document_type`	boolean	no
`audience`	Audience or null	no	The document’s reader. `value` is one of the `choices` or the `actor` from `kb_list_audiences`. Set `status` to `confirmed` only after the person confirms the value.

EvidenceMark

How well the sources back the proposed text. suggested marks your own wording. Type: supported, partly, conflicting or suggested.

FileChange

Type: FileCreated or FileDeleted or FileMoved or FileEdited.

FileCreated

Field	Type	Required
`change`	`created`	yes
`path`	Path	yes
`fingerprint`	Fingerprint or null	no

FileDeleted

Field	Type	Required	Meaning
`change`	`deleted`	yes
`path`	Path	yes

FileEdited

Field	Type	Required
`change`	`edited`	yes
`path`	Path	yes
`fingerprint`	Fingerprint	yes

FileMoved

Field	Type	Required	Meaning
`change`	`moved`	yes
`path`	Path	yes	The path after the move.
`old_path`	Path	yes
`fingerprint`	Fingerprint or null	no

FilingReview

Field	Type	Required	Meaning
`folder`	string	yes	Folder relative to the knowledge-base root; empty for the root.
`recursive`	boolean or null	no	Include descendants; false limits the review to direct children.

FilingValue

Field	Type	Required
`path`	Path	yes
`universe_spec`	string	yes
`document_type`	string	yes
`properties`	object or null	no
`content`	string or null	no

Fingerprint

A value that changes only when the file content changes, such as SHA-256 or Drive’s md5Checksum. kb_prepare_document_types uses fingerprints to find files in listing that moved. Type: string.

KnowledgeBusFolder

Field	Type	Required	Meaning
`folder`	string	yes	Path from the knowledge-base root, such as `team/notes`. Empty for the root folder.
`files`	list of SpecFile	no	Every `*.kbp.yaml` file directly inside the `.knowledge-bus/` folder.
`workspace_yaml`	string or null	no	The text of `.knowledge-bus/workspace.yaml`.

Layout

Type: list or table.

LeftOutFile

Field	Type	Required	Meaning
`file`	string	yes
`reason`	string	yes

LineSource

A line in a text file.

Field	Type	Required	Meaning
`file`	string	yes
`line_number`	integer	yes

LinkBinding

An independently verified original target for a complete internal link token.

Field	Type	Required	Meaning
`source_path`	MovePath	yes	The document containing the link, at its original path.
`start`	integer	yes	Zero-based Unicode code-point offset of the complete link token’s first character in the original supplied text, including any embed marker.
`end`	integer	yes	Exclusive Unicode code-point offset after the complete original link token, including its label, fragment and title when present. The range `start:end` covers the whole token, not just the destination path.
`target_path`	MovePath	yes	The link’s established target in the original inventory, before any move.

ListedFile

Field	Type	Required	Meaning
`path`	Path	yes
`fingerprint`	Fingerprint or null	no

MoveDocument

Field	Type	Required	Meaning
`path`	MovePath	yes
`text`	string	yes

MovePath

Path relative to the knowledge-base root, with forward slashes between folders. Type: string, pattern ^[^/\\\u0000]+(?:/[^/\\\u0000]+)*$.

Part

Type: ConventionDocumentTypePart or ConventionDatePart or ConventionPropertyPart or ConventionContentPart or ConventionLiteralPart.

Path

Path from the knowledge base’s root folder, with / between folders, such as docs/rfcs/0042-cache.md. Type: string.

PersonSource

The person’s words in this conversation.

Field	Type	Required	Meaning
`said`	string	yes

PlaceSource

A place in a sheet or deck.

Field	Type	Required	Meaning
`file`	string	yes
`place`	string	yes	Such as `Evening!A2:D10` or `slide 7`.

ProposalCell

Field	Type	Required	Meaning
`label`	string or null	no	The field or section, such as `Title`.
`text`	string	yes	Plain words, without markdown syntax.

ProposalRow

Field	Type	Required	Meaning
`current`	ProposalCell or null	no	The document’s text now. Omit it for an addition.
`proposed`	ProposalCell	yes
`mark`	EvidenceMark or null	no
`sources`	list of LineSource or PlaceSource or PersonSource	yes

RemoveConvention

Field	Type	Required
`change`	`remove`	yes
`universe_spec`	string	yes
`document_type`	string	yes

SetBy

person when the person stated the document type or reader. An entry the person set wins over any later entry by the agent. Type: agent or person.

SpecFile

Field	Type	Required	Meaning
`name`	string	yes	The file name, such as `universe.kbp.yaml`.
`id`	string	yes	The `id` value in the file’s `universe:` or `guidance:` block.
`version`	string	yes	The `version` value in the file’s `universe:` or `guidance:` block, as written.
`text`	string or null	no	The full file text. Send fresh text whenever the file changes. Reuse `digest` while the text stays unchanged. Leave it out when `id` and `version` match a bundled file, except in kbp_validate.
`digest`	string or null	no	File SHA-256 (`sha256:…`); send exact text if unknown. kbp_validate requires previously sent text.

UpsertConvention

Field	Type	Required
`change`	`upsert`	yes
`universe_spec`	string	yes
`document_type`	string	yes
`folder`	list of ConventionSegment or Part	yes
`name`	ConventionName	yes
`content`	ConventionContent or null	no
`set_by`	SetBy	yes

Terms

Term	Meaning
universe spec	A `*.kbp.yaml` file that declares document types and their questions
card	A summary from `kbp_card` with sections, questions and conditions for one document type
kind	In `kbp_card`, a document type id. In `kbp_mint`, the category of code to mint
actor	The role that uses a document type, such as maintainer
element	A question answered by a document section
artifact	A document type declared in a universe spec
frame	A setting used to order, select or require document types and sections
factor	A question you can use to choose writing advice without changing document structure

From the terminal

Run kb type --help for terminal usage.

​File access and side effects

​Tools

​Arguments

​kb_get_document_type

​kb_list_audiences

​kb_list_convention_templates

​kb_list_conventions

​kb_list_edits

​kb_prepare_conventions

​kb_prepare_document_move

​kb_prepare_document_moves

​kb_prepare_document_types

​kb_prepare_import

​kb_prepare_proposal

​kb_record_edit

​kbp_card

​kbp_explore

​kbp_inspect

​kbp_kinds

​kbp_mint

​kbp_self_check

​kbp_validate

​kbp_version

​Shapes

​AllowedBy

​Audience

​Change

​ConventionContent

​ConventionContentPart

​ConventionDatePart

​ConventionDocumentTypePart

​ConventionFile

​ConventionFile1

​ConventionFile2

​ConventionLiteralPart

​ConventionName

​ConventionPropertyPart

​ConventionReference

​ConventionSegment

​ConventionsFolder

​Digest

​DocumentMove

​EditOperation

​EntryItem

​EvidenceMark

​FileChange

​FileCreated

​FileDeleted

​FileEdited

​FileMoved

​FilingReview

​FilingValue

​Fingerprint

​KnowledgeBusFolder

​Layout

​LeftOutFile

​LineSource

​LinkBinding

​ListedFile

​MoveDocument

​MovePath

​Part

​Path

​PersonSource

​PlaceSource

​ProposalCell

​ProposalRow

​RemoveConvention

​SetBy

​SpecFile

​UpsertConvention

​Terms

​From the terminal