Skip to main content
Glama

pin_note

Pin a note to Caddie's sidebar (it goes last among the pinned).

Input Schema

NameRequiredDescriptionDefault
idYes
workspaceNoWhich Caddie: leave it out for the user's personal one, or give a team workspace's name or id (list_workspaces). Use the same one you found the item in.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

C2.7/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full disclosure burden. It does add one useful trait — the pinned position is appended last — but says nothing about idempotency on re-pin, permission/workspace requirements, or the effect on other pinned notes.

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?

A single short sentence with the action front-loaded and the ordering behavior tucked into a parenthetical. No wasted words, though it is arguably too terse for a mutation tool.

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?

With no annotations and no output schema, the description should cover success/failure semantics, already-pinned behavior, and workspace defaults. Only the sidebar placement is covered, leaving an agent unable to predict outcomes when calling it.

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 coverage is 50%: the workspace parameter is well documented in the schema itself, but id has no description anywhere. The tool description adds nothing about which id is expected (e.g. from search_notes/get_note) or how workspace scoping affects resolution.

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?

Specific verb + resource + destination: 'Pin a note to Caddie's sidebar'. It also discloses the resulting ordering ('goes last among the pinned'), which is a real behavioral detail. It doesn't explicitly distinguish itself from unpin_note, though the names make that pair self-evident.

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

Usage Guidelines2/5

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

There is no statement of when to pin versus other organizational actions (collections, move_note), no prerequisite that the note must exist, and no guidance on what happens if the note is already pinned. Usage is only implied by the verb.

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