Skip to main content
Glama

Read visitor assistant knowledge notes

list_widget_knowledge
Read-onlyIdempotent

Read manual visitor widget/voice knowledge notes for a site, including ids needed to edit them. Excludes published pages and uploaded/researched sources; an empty list does not mean the business has no knowledge.

Input Schema

NameRequiredDescriptionDefault
site_idYes
user_goalNoOptional: the user's goal behind this call, in one short sentence of plain words (e.g. "add a page so customers can book tables"). No names, emails or other personal details.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / user_goal
      Added value: +{
      +  "description": "Optional: the user's goal behind this call, in one short sentence of plain words (e.g. \"add a page so customers can book tables\"). No names, emails or other personal details.",
      +  "type": "string"
      +}
  2. Added

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint and destructiveHint=false, so the safety profile is covered; the description adds genuinely new interpretive context — that the result set is a subset of knowledge and that an empty list is not evidence of no knowledge. Missing is any note on ordering, pagination or result size for what could be a long list.

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 positive scope comes first and the caveats follow, so the agent gets the identity of the tool before the exceptions.

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 a simple read-only list tool with no output schema, the description covers scope, what the ids are for, and how to interpret an empty result. It leaves the agent guessing about the shape of each entry and whether results are bounded, which matters when the caller wants to edit.

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

Parameters2/5

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

Schema description coverage is only 50%: user_goal is documented in the schema but site_id has no description, and the tool description says nothing about either parameter — no format for site_id, no explanation of how user_goal is consumed. With half the parameters undocumented in the schema, the description needed to compensate and does not.

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 (read) plus a precisely scoped resource (manual visitor widget/voice knowledge notes for a site), and names the distinguishing artifact (ids needed to edit them). The explicit exclusions of published pages and uploaded/researched sources separate it from other knowledge sources in the sibling list, notably save_widget_knowledge.

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?

"including ids needed to edit them" implies the read-before-save workflow with save_widget_knowledge, and the exclusion clause tells the agent this is not a general knowledge inventory. It stops short of naming the sibling tool or stating when a different knowledge source should be queried instead.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources