/docs/tools
Tools.
Your agent gets these 6 tools. They’re generated from the same procedures the MindMap web app calls, so your agent and the canvas get the same results and the same errors. Create, read and edit results include the map’s url.
list_mindmaps
List mind maps. List the user's mind maps, most recently updated first, with each map's url. Pass the returned nextCursor as cursor to read the next page. Users can have up to 200 maps.
{
"limit": 20
}{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"cursor": {
"type": "string",
"minLength": 1
},
"limit": {
"default": 50,
"type": "integer",
"minimum": 1,
"maximum": 100
}
}
}get_mindmap
Read a mind map. Read one mind map: its version, url, nested tree with node ids, and a Markdown outline where each node begins with its [n_id] tag.
{
"id": "map_k2x9p4q7"
}{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^map_[a-z0-9]+$"
}
},
"required": [
"id"
]
}create_mindmap
Create a mind map. Create a mind map from a nested tree and return a receipt with its url and new node IDs; give the url to the user. The root's text is the central topic; aim for 3-7 short branch labels. Limits: 2000 nodes and 64 levels per map, 280 characters per node, 4000 per note.
{
"title": "Launch plan",
"root": {
"text": "Launch",
"children": [
{
"text": "Audience"
},
{
"text": "Channels",
"children": [
{
"text": "Email"
}
]
}
]
}
}{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1,
"maxLength": 280
},
"root": {
"$ref": "#/$defs/__schema0"
},
"idempotencyKey": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{8,64}$",
"description": "Retrying with the same key and input returns the first result instead of repeating it."
}
},
"required": [
"title"
],
"$defs": {
"__schema0": {
"type": "object",
"properties": {
"text": {
"type": "string",
"minLength": 1,
"maxLength": 280
},
"note": {
"type": "string",
"maxLength": 4000
},
"children": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
}
},
"required": [
"text"
]
}
}
}edit_mindmap
Edit a mind map. Apply a batch of operations to one map atomically: all succeed or none do. Call get_mindmap first and pass its version as expectedVersion; on VERSION_CONFLICT, read again and retry. Operations: add {parent, text, note?, after?, ref?, children?}, update {node, text?, note?, collapsed?}, move {node, parent, after?, side?}, delete {node} (removes the subtree), rename {title}. Give a new node a ref like "$intro" to use it as a parent later in the same batch. The result's refs map each $ref to its new node id. The immutable receipt includes the applied version and summary. Read the current tree separately with get_mindmap. Up to 500 operations per call; maps hold up to 2000 nodes.
{
"id": "map_k2x9p4q7",
"expectedVersion": 3,
"operations": [
{
"op": "add",
"ref": "$risks",
"parent": "n_root01",
"text": "Risks"
},
{
"op": "add",
"parent": "$risks",
"text": "Budget"
}
]
}{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^map_[a-z0-9]+$"
},
"operations": {
"minItems": 1,
"maxItems": 500,
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"op": {
"type": "string",
"const": "add"
},
"ref": {
"type": "string",
"pattern": "^\\$[A-Za-z0-9_-]+$"
},
"parent": {
"anyOf": [
{
"type": "string",
"pattern": "^n_[a-z0-9]+$"
},
{
"type": "string",
"pattern": "^\\$[A-Za-z0-9_-]+$"
}
]
},
"after": {
"anyOf": [
{
"type": "string",
"pattern": "^n_[a-z0-9]+$"
},
{
"type": "null"
}
],
"description": "Sibling to place the node after; null places it first; omit to place it last."
},
"side": {
"type": "string",
"enum": [
"left",
"right"
],
"description": "Only for children of the root: which side the branch sits on. Omit to balance automatically."
},
"id": {
"type": "string",
"pattern": "^n_[a-z0-9]+$",
"description": "Optional id for the new node; must be unused in this map."
},
"text": {
"type": "string",
"minLength": 1,
"maxLength": 280
},
"note": {
"type": "string",
"maxLength": 4000
},
"collapsed": {
"type": "boolean"
},
"children": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
}
},
"required": [
"op",
"parent",
"text"
]
},
{
"type": "object",
"properties": {
"op": {
"type": "string",
"const": "update"
},
"node": {
"type": "string",
"pattern": "^n_[a-z0-9]+$"
},
"text": {
"type": "string",
"minLength": 1,
"maxLength": 280
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 4000
},
{
"type": "null"
}
]
},
"collapsed": {
"type": "boolean"
}
},
"required": [
"op",
"node"
]
},
{
"type": "object",
"properties": {
"op": {
"type": "string",
"const": "move"
},
"node": {
"type": "string",
"pattern": "^n_[a-z0-9]+$"
},
"parent": {
"anyOf": [
{
"type": "string",
"pattern": "^n_[a-z0-9]+$"
},
{
"type": "string",
"pattern": "^\\$[A-Za-z0-9_-]+$"
}
]
},
"after": {
"anyOf": [
{
"type": "string",
"pattern": "^n_[a-z0-9]+$"
},
{
"type": "null"
}
],
"description": "Sibling to place the node after; null places it first; omit to place it last."
},
"side": {
"type": "string",
"enum": [
"left",
"right"
],
"description": "Only for children of the root: which side the branch sits on. Omit to balance automatically."
}
},
"required": [
"op",
"node",
"parent"
]
},
{
"type": "object",
"properties": {
"op": {
"type": "string",
"const": "delete"
},
"node": {
"type": "string",
"pattern": "^n_[a-z0-9]+$"
}
},
"required": [
"op",
"node"
]
},
{
"type": "object",
"properties": {
"op": {
"type": "string",
"const": "rename"
},
"title": {
"type": "string",
"minLength": 1,
"maxLength": 280
}
},
"required": [
"op",
"title"
]
}
]
}
},
"expectedVersion": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"idempotencyKey": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{8,64}$",
"description": "Retrying with the same key and input returns the first result instead of repeating it."
}
},
"required": [
"id",
"operations"
],
"$defs": {
"__schema0": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^n_[a-z0-9]+$",
"description": "Optional id for the new node; must be unused in this map."
},
"text": {
"type": "string",
"minLength": 1,
"maxLength": 280
},
"note": {
"type": "string",
"maxLength": 4000
},
"collapsed": {
"type": "boolean"
},
"children": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
}
},
"required": [
"text"
]
}
}
}delete_mindmap
Delete a mind map. Permanently delete a whole map. This cannot be undone; confirm with the user first. Pass the map's exact current title as confirmTitle.
{
"id": "map_k2x9p4q7",
"confirmTitle": "Launch plan"
}{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^map_[a-z0-9]+$"
},
"confirmTitle": {
"type": "string"
}
},
"required": [
"id",
"confirmTitle"
]
}get_mindmap_activity
Read a map's activity. List recent changes to one map, newest first: who made them (the user or a named agent) and what changed. Use it to see what the user edited since you last read the map.
{
"id": "map_k2x9p4q7",
"limit": 20
}{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^map_[a-z0-9]+$"
},
"cursor": {
"type": "string",
"minLength": 1
},
"limit": {
"default": 50,
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"required": [
"id"
]
}