Skip to main content
Glama
dnotitia

akb

by dnotitia
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Hybrid

akb_browse

Explore vault content—documents, tables, and files—using tree-depth, filters, and content-type options to find specific resources.

Instructions

Browse ALL vault content — documents, tables, and files — under a browse root. The browse root can be addressed two ways: pass a canonical uri (akb://V for vault root or akb://V/coll/X for a collection), or the legacy vault + optional collection pair. Use the URI form when drilling down from a previous response — every item carries a uri that can be pasted straight back in.

depth is tree-depth from the browse root, mirroring tree -L N: 0 = direct children only (no descent), N = descend N collection levels, -1 = entire subtree. Collection rows are always emitted as navigation aids regardless of depth.

The response includes metadata for the current browse root in context, and collection items include summary by default so agents understand their intended purpose. Other resource summaries stay opt-in so large vaults fit in the agent's context window. Returns {vault, path, context, items, total, returned, truncated?, hint?}.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
uriNoCanonical browse target: `akb://{vault}` (vault root) or `akb://{vault}/coll/{path}` (collection-scoped). Takes precedence over `vault` + `collection` when both are given.
depthNoTree depth from the browse root. 0 = direct children only (no descent into any collection). N = descend N collection levels. -1 = unbounded (entire subtree). Collections themselves are always emitted regardless of depth.
limitNoCap returned item count.
vaultNoVault name. Required unless `uri` is given.
filterNoSubstring filter on item name/path (case-insensitive).
offsetNoSkip first N items (default 0).
collectionNoCollection path to use as the browse root (omit for vault root). Ignored when `uri` is given.
content_typeNoFilter by content typeall
include_hashesNoInclude AKB-certified content_hash/hash_algorithm and resource version fields for documents/files.
include_summaryNoInclude document, table, and file summaries. Collection summaries and browse-root context are always included.
include_archivedNoInclude archived documents. Default false — `status: archived` docs are hidden from browse.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv2.0.14
    • changedInput schema / properties / include_summary / description
      Previous value: -"Include the per-item summary field (default false, drops to keep payload small)."New value: +"Include document, table, and file summaries. Collection summaries and browse-root context are always included."
  2. Changed10 schema fields changedv2.0.7
    • changedInput schema / properties / collection / description
      Previous value: -"Collection path to browse into (omit for top-level)"New value: +"Collection path to use as the browse root (omit for vault root). Ignored when `uri` is given."
    • changedInput schema / properties / depth / description
      Previous value: -"1=collections only, 2=collections+documents"New value: +"Tree depth from the browse root. 0 = direct children only (no descent into any collection). N = descend N collection levels. -1 = unbounded (entire subtree). Collections themselves are always emitted regardless of depth."
    • removedInput schema / properties / depth / maximum
      Removed value: -2
    • changedInput schema / properties / depth / minimum
      Previous value: -1New value: +-1
    • addedInput schema / properties / include_archived
      Added value: +{
+  "default": false,
+  "description": "Include archived documents. Default false — `status: archived` docs are hidden from browse.",
+  "type": "boolean"
+}
    • addedInput schema / properties / include_hashes
      Added value: +{
+  "description": "Include AKB-certified content_hash/hash_algorithm and resource version fields for documents/files.",
+  "type": "boolean"
+}
    • removedInput schema / properties / query
      Removed value: -{
-  "description": "DEPRECATED alias for `filter`. Use `filter` in new code.",
-  "type": "string"
-}
    • addedInput schema / properties / uri
      Added value: +{
+  "description": "Canonical browse target: `akb://{vault}` (vault root) or `akb://{vault}/coll/{path}` (collection-scoped). Takes precedence over `vault` + `collection` when both are given.",
+  "type": "string"
+}
    • changedInput schema / properties / vault / description
      Previous value: -"Vault name"New value: +"Vault name. Required unless `uri` is given."
    • removedInput schema / required
      Removed value: -[
-  "vault"
-]
  3. Addedv2.0.4
  4. Removedv2.0.1
  5. First observedv0.1.0

TDQS

A4/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the behavioral burden and does so well: it discloses depth semantics, that collection rows are always emitted, default summary behavior, and the exact response shape including `truncated?` and `hint?`. It does not explicitly confirm that browsing is read-only or discuss permission requirements, but for a browse operation the disclosed behavior is substantial.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is longer than a minimal definition but every sentence earns its place: purpose, addressing modes, depth semantics, summary behavior, and response shape. It is front-loaded with the primary purpose and then structured logically, though it could be tightened slightly by naming sibling exclusions.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For an 11-parameter tool with no output schema, the description is remarkably complete: it covers both addressing modes, depth behavior, summary defaults, and the return object. The remaining omissions, such as explicit pagination semantics or permissions, are minor because the schema already documents offset, limit, filter, and content_type.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema already covers 100% of parameters, so the baseline is 3; the description adds value beyond the schema with the `tree -L N` analogy for depth, the URI-precedence rationale for drilling down, and the context-window rationale for `include_summary`. Not every parameter is enriched, but the key ones gain meaningful context.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description opens with a specific verb-resource pair: 'Browse ALL vault content — documents, tables, and files — under a browse root.' It clearly indicates the broad traversal scope, which differentiates it from item-level operations like akb_get. However, it never explicitly names or contrasts sibling tools such as akb_drill_down or akb_search, so it falls just short of full sibling differentiation.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description gives concrete in-tool guidance: use the URI form when drilling down from a previous response, and use depth semantics to control how far to descend. It also explains why summaries are opt-in for large vaults, helping the agent decide parameters. It does not explicitly tell the agent when to choose akb_browse over alternatives like akb_drill_down or akb_search, so no exclusions or alternatives are stated.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools