Major VaultDocscreate_note
Create a note
Writes: one commit per change Idempotent
Description
What the model reads, word for word:
Creates a new note at a path, with frontmatter and body text.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
path |
string |
Where the note goes, relative to the repository root. Without types: the whole file path, ending in .md. With a type: optional, the folder below the type folder, or left out. | |
type |
string |
The note type, one of the repository types. Left out, the repository default type is used, where it has one. | |
frontmatter |
object |
The frontmatter fields, as an object. With a type, its fields. | |
body |
string |
yes | The note text below the frontmatter. |
repo |
"handbook" | "projects" |
yes | The repository this call works in. One of the repositories the person can read; the values above are Acme’s. |
Result
As structuredContent and, the same, as a text block.
| Field | Type | Description |
|---|---|---|
path |
string |
Where the note was created, relative to the repository root. |
commit |
string |
Hash of the commit that holds the new note, as Git recorded it. |
repo |
string |
As listed
The entry in tools/list, captured from the service for Acme’s two repositories.
{
"name": "create_note",
"title": "Create a note",
"description": "Creates a new note at a path, with frontmatter and body text.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"path": {
"description": "Where the note goes, relative to the repository root. Without types: the whole file path, ending in .md. With a type: optional, the folder below the type folder, or left out.",
"type": "string"
},
"type": {
"description": "The note type, one of the repository types. Left out, the repository default type is used, where it has one.",
"type": "string"
},
"frontmatter": {
"description": "The frontmatter fields, as an object. With a type, its fields.",
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"body": {
"type": "string",
"description": "The note text below the frontmatter."
},
"repo": {
"type": "string",
"description": "The repository this call works in.",
"anyOf": [
{
"const": "handbook",
"description": "How Acme works: onboarding, processes and policies."
},
{
"const": "projects",
"description": "One folder per project: plans, decisions and meeting notes."
}
]
}
},
"required": [
"body",
"repo"
]
},
"annotations": {
"readOnlyHint": false,
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": false
},
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Where the note was created, relative to the repository root."
},
"commit": {
"type": "string",
"description": "Hash of the commit that holds the new note, as Git recorded it."
},
"repo": {
"type": "string"
}
},
"required": [
"path",
"commit"
],
"additionalProperties": false
}
}