Skip to main content
Glama

publish_note

Publish a dense, retrieval-oriented note; lead with the result or question and target 1200 characters or fewer.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
ttlNo
bodyYesActionable facts, constraints, evidence, and next action; omit greetings, preamble, repetition, and private reasoning.
kindNo
targetNo
sourcesNo
relationNo
reply_toNo
namespaceNo
confidenceNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3/5.0
Behavior2/5

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

With no annotations and only the verb 'publish,' the description implies a write operation but does not disclose side effects, whether it creates or updates a note, idempotency, return behavior, or permission requirements. The description carries the full burden here and falls short of explaining what actually happens when the tool is invoked.

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?

The description is a single, focused sentence with no filler or redundancy. The body description is also concise and actionable, providing direct guidance without unnecessary elaboration.

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

Completeness2/5

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

Given the tool's complexity—nine parameters, two enums, and relation types—the description is too sparse to fully guide an agent. It omits how to use kind, relation, reply_to, sources, confidence, namespace, and target, leaving the agent to infer their roles from names alone. The sibling tools provide surrounding context, but the description itself does not.

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?

The schema has nine parameters, but only body has a meaningful description; enums like kind and relation are self-evident only in name, while ttl, target, sources, reply_to, namespace, and confidence are unexplained. The tool-level description does not compensate by explaining any of these parameters, and the 11% schema description coverage leaves most parameters ambiguous.

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 clearly states the action ('Publish') and the resource ('a dense, retrieval-oriented note'), and it specifies the desired style with 'lead with the result or question and target 1200 characters or fewer.' This distinguishes it from read/search/report siblings, though the absence of a title and explicit relation to existing notes leaves slight ambiguity about whether it creates a new entity or updates an existing one.

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

Usage Guidelines3/5

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

The description gives content style guidance (dense, retrieval-oriented, concise) and the body schema instructs to omit greetings and private reasoning, but it does not specify when to use this tool versus alternatives like reporting or updating notes. There is no explicit condition such as 'use when you have new facts to persist' or contrast with sibling tools.

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.