read_property
Read a single frontmatter property. Set nested=true to address a dotted path (e.g. meta.author.name) through nested objects. response_format=concise omits the key and nested echoes.
| Domain | metadata |
| Scopes | read:notes |
| Access | read |
| Tags | read-only, domain:metadata |
| Profile | core, full |
Annotations
Section titled “Annotations”| Annotation | Value |
|---|---|
| Read-only | yes |
| Destructive | no |
| Idempotent | no |
| Accepts an idempotency key | no |
Idempotent is the advisory MCP idempotentHint. Destructive is also yes for a tool that
asks for confirmation only on some calls.
Confirmation (human in the loop)
Section titled “Confirmation (human in the loop)”No human confirmation is required to call this tool.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
vault |
string |
— | Vault id. May be omitted when only one vault is available. length 1–64; pattern ^[a-z0-9_-]+$ |
|
path |
string |
yes | — | length 1–1024 |
key |
string |
yes | — | length ≥ 1 |
nested |
boolean |
false |
— | |
response_format |
enum |
— | concise returns only the high-signal fields; detailed (the shipped default) returns the full payload. Errors and safety warnings are never trimmed. When omitted, the server’s tools.defaults.responseFormat applies. One of: "concise", "detailed" |
|
verbosity |
enum |
— | Legacy alias for response_format: terse = concise, full = detailed. One of: "full", "terse" |
Output
Section titled “Output”| Field | Type | Always present | Description |
|---|---|---|---|
vault |
string |
yes | — |
path |
string |
yes | — |
key |
string |
— | |
value |
any |
yes | — |
found |
boolean |
yes | — |
nested |
boolean |
— |
Related tools
Section titled “Related tools”Other tools in the metadata domain: add_tag, bulk_set_property, find_notes_by_property, find_notes_by_tag, get_note_tags, list_properties, list_tags, read_frontmatter, read_metadata_fields, remove_tag, suggest_tags, update_frontmatter.
Back to the tool catalog.