Seal a file as a KNOBE document
knobe_seal_fileSeal a text or markdown file into a KNOBE Protocol v1 document with cryptographic integrity and human-confirmed authorship.
Instructions
Seal an existing text/markdown file (e.g. the output of a document conversion) into a KNOBE Protocol v1 document with a cryptographic payload and body hash.
Before sealing, the user is asked (via elicitation) to confirm or change the author — pass 'author' as the proposal. If the client cannot elicit, 'author' or the KNOBE_DEFAULT_AUTHOR env var is required.
Args:
path (string): file whose content becomes the sealed body.
output_path (string, optional): where to write the sealed document. Default: source path with a .knobe.md suffix.
title (string, optional): sealed title. Default: source filename without extension.
author, summary, content_type, license, privacy_level, language, tags, contribution, overwrite: see field descriptions.
Returns: text summary plus structured {output_path, title, author, payload_hash, state, conformance}.
Errors:
"declined by the user" — the user rejected the author prompt; do not retry unprompted.
"already exists" — pass overwrite=true or a different output_path.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes | Path to the source file to seal. | |
| tags | No | Tags sealed into the payload. | |
| title | No | Title sealed into the payload. Default: filename. | |
| author | No | Proposed author (person or organization) for the sealed attribution. The user is asked to confirm or change it before sealing unless KNOBE_NO_CONFIRM is set. | |
| license | No | License string sealed into the payload. Default: 'CC BY 4.0'. | |
| summary | No | One-paragraph summary sealed into the payload. | |
| language | No | BCP-47 language tag of the body, e.g. 'en'. | |
| overwrite | No | Replace the output file if it already exists. Default: false. | |
| output_path | No | Destination for the sealed .knobe.md. Default: derived from path. | |
| content_type | No | KNOBE content_type (e.g. 'original', 'adaptation', 'summary'). Default: 'original'. | |
| contribution | No | What the author contributed. Default: 'author'. | |
| privacy_level | No | KNOBE privacy_level (e.g. 'public', 'internal'). Default: 'public'. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| state | Yes | ||
| title | Yes | ||
| author | Yes | ||
| conformance | Yes | ||
| output_path | Yes | ||
| payload_hash | Yes |