Skip to main content
Glama
Sign In

Aide

by app.aide
OverviewDiscussionsAdmin

List knowledge documents

list_knowledge_documents
Read-only

List the workspace's knowledge documents (articles, snippets, web pages, products, macros, transcripts) with their ids, titles, source ids, kinds, status, excerpts and links: newest first, or best match first with q. Read one in full with get_knowledge_document; to answer a question, search_knowledge ranks passages instead.

Input Schema

NameRequiredDescriptionDefault
qNoWords to match in the title or text.
kindNoOnly documents of this kind.
pageNoPage number, 1 to 500; `metadata.hasMore` says whether another page follows.
statusNoOnly documents with this status; drafts and archived documents are not used in answers.
perPageNoDocuments per page (at most 200).
starredNoOnly starred (true) or unstarred (false) documents.
sourceIdNoOnly documents of this knowledge source (an id from list_knowledge_sources).
collectionIdNoOnly documents in this collection (an id from list_knowledge_collections).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / kind / enum
      Previous value: -[
-  "article",
-  "product",
-  "macro",
-  "web_page",
-  "transcript"
-]New value: +[
+  "article",
+  "snippet",
+  "product",
+  "macro",
+  "web_page",
+  "transcript"
+]
  2. Changed2 schema fields changed
    • addedInput schema / properties / collectionId
      Added value: +{
+  "description": "Only documents in this collection (an id from list_knowledge_collections).",
+  "maxLength": 64,
+  "minLength": 1,
+  "type": "string"
+}
    • addedInput schema / properties / starred
      Added value: +{
+  "description": "Only starred (true) or unstarred (false) documents.",
+  "type": "boolean"
+}
  3. Changed2 schema fields changed
    • addedInput schema / properties / kind / type
      Added value: +"string"
    • addedInput schema / properties / status / type
      Added value: +"string"
  4. First observed

TDQS

A4.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false and openWorldHint=false, so safety needs no restating. The description adds genuinely non-obvious behavior beyond them: default ordering is newest first, and supplying q switches ordering to best match. It does not mention pagination defaults, though the schema's page/perPage docs already cover hasMore.

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

Conciseness5/5

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

Two sentences, zero filler. The primary purpose and returned fields are front-loaded, and the routing guidance follows as a compact contrast between the three knowledge tools.

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

Completeness5/5

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

With 8 optional parameters and no output schema, the description carries the burden of telling the agent what comes back, and it does so by listing the returned fields plus the ordering rule. Combined with the sibling routing hints and fully documented schema, an agent has everything needed to call it correctly.

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?

Schema description coverage is 100%, so the baseline is 3, but the description adds meaning the schema does not: q is not merely a filter, it changes result ordering to relevance, and the parenthetical kind list mirrors the enum for at-a-glance recognition. It stops short of explaining the interaction between q and the kind/status/starred filters.

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

Purpose5/5

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

States a specific verb and resource (list the workspace's knowledge documents), enumerates the document kinds covered, and names the exact fields returned (ids, titles, source ids, kinds, status, excerpts, links). It also distinguishes itself from both get_knowledge_document and search_knowledge by name, so an agent can route without opening any schema.

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

Usage Guidelines5/5

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

The closing sentence gives explicit alternatives with selecting conditions: read one in full via get_knowledge_document, answer a question via search_knowledge (which ranks passages instead). That leaves no ambiguity about when this enumeration tool is the right choice versus the retrieval tools.

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

All Aide toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources