Skip to main content
Glama

get_note_by_id_api_v1_notes

Retrieve a specific note from OpenWebUI by providing its unique ID.

Instructions

Get Note By Id

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior1/5

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

No annotations are provided, so the description must convey behavioral traits. However, it only says 'Get Note By Id' with no mention of read-only nature, authentication requirements, error handling (e.g., if note not found), or any side effects.

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

Conciseness2/5

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

The description is extremely short (4 words), but this is not conciseness; it is under-specification. While brevity is valued, the description fails to include essential context that could be conveyed in a few more words.

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

Completeness1/5

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

Given the presence of an output schema, the description should at least hint at the return value (e.g., note details). It does not. Additionally, with many sibling note tools, the description lacks completeness to distinguish its functionality.

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

Parameters1/5

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

The schema description coverage is 0%, meaning the JSON schema provides no description for the 'id' parameter. The tool description adds no information about what 'id' represents (e.g., note UUID) or its format, leaving the agent with only the parameter name.

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

Purpose1/5

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

The description 'Get Note By Id' is essentially a tautology of the tool name. It does not specify that it retrieves a single note by its unique identifier, nor does it differentiate from sibling tools like 'get_notes_api_v1_notes' (list notes) or 'search_notes_api_v1_notes_search_get'.

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

Usage Guidelines1/5

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

The description provides no guidance on when to use this tool versus alternatives. For example, it does not indicate that this is for fetching a specific note by ID, as opposed to listing or searching notes. No when-to-use or when-not-to-use information is given.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/TETRA-2023/open-webui-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server