base_view
Show a table from the notes
Reads only
Description
What the model reads, word for word:
Shows a table built from the notes, as a view defines it.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
path |
string |
yes | The table definition, relative to the vault root, ending in .base, for example “projects/apollo/Overview.base”. |
view |
string |
Which of the file’s views to show, by its name. Leave it out for the first one. A wrong name comes back with the list of names that exist. | |
limit |
integer |
How many rows to return. Fewer means a shorter answer. At least 1. At most 200. Default 50. |
|
offset |
integer |
How many rows to skip. An answer with more after it names the next offset. Default 0. |
|
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 |
The .base file that was read. |
view |
string |
The view that was rendered. |
availableViews |
string[] |
|
columns |
object[] |
|
columns[].property |
string |
The note field this column shows. |
columns[].label |
string |
The heading, as the file names it. |
rows |
object[] |
|
rows[].path |
string |
Path of the note, relative to the vault root. |
rows[].cells |
string[] |
|
rows[].repo |
string |
|
total |
number |
How many notes the view holds in all, before paging. |
offset |
number |
How many rows were skipped before this page. |
hasMore |
boolean |
True when more rows follow after this page. |
note |
string |
|
repo |
string |
As listed
The entry in tools/list, captured from the service for Acme’s two repositories.
{
"name": "base_view",
"title": "Show a table from the notes",
"description": "Shows a table built from the notes, as a view defines it.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"path": {
"type": "string",
"minLength": 1,
"description": "The table definition, relative to the vault root, ending in .base, for example \"projects/apollo/Overview.base\"."
},
"view": {
"description": "Which of the file's views to show, by its name. Leave it out for the first one. A wrong name comes back with the list of names that exist.",
"type": "string"
},
"limit": {
"default": 50,
"description": "How many rows to return. Fewer means a shorter answer.",
"type": "integer",
"minimum": 1,
"maximum": 200
},
"offset": {
"default": 0,
"description": "How many rows to skip. An answer with more after it names the next offset.",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"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": [
"path",
"repo"
]
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false
},
"outputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "The .base file that was read."
},
"view": {
"type": "string",
"description": "The view that was rendered."
},
"availableViews": {
"type": "array",
"items": {
"type": "string"
}
},
"columns": {
"type": "array",
"items": {
"type": "object",
"properties": {
"property": {
"type": "string",
"description": "The note field this column shows."
},
"label": {
"type": "string",
"description": "The heading, as the file names it."
}
},
"required": [
"property",
"label"
],
"additionalProperties": false
}
},
"rows": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Path of the note, relative to the vault root."
},
"cells": {
"type": "array",
"items": {
"type": "string"
}
},
"repo": {
"type": "string"
}
},
"required": [
"path",
"cells"
],
"additionalProperties": false
}
},
"total": {
"type": "number",
"description": "How many notes the view holds in all, before paging."
},
"offset": {
"type": "number",
"description": "How many rows were skipped before this page."
},
"hasMore": {
"type": "boolean",
"description": "True when more rows follow after this page."
},
"note": {
"type": "string"
},
"repo": {
"type": "string"
}
},
"required": [
"path",
"view",
"availableViews",
"columns",
"rows",
"total",
"offset",
"hasMore"
],
"additionalProperties": false
}
}