Skip to main content
Glama

write_pin

Pin or unpin a LeafWiki page to control whether it appears at the top of its sibling pages.

Instructions

Pin a page to the top of its siblings, or unpin it.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "page": "<page>",
      "pinned": "<pinned>"
    },
    "name": "write_pin"
  }
}

Input Schema

NameRequiredDescriptionDefault
pageYesPage id or path
pinnedYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.0

TDQS

B3.3/5.0
Behavior3/5

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

Annotations declare openWorldHint=false and destructiveHint=false, so the safety profile is already partly covered; notably there is no readOnlyHint, consistent with a mutation. The description adds that the tool is bidirectional via the pinned flag, but says nothing about permissions required, whether pins survive a write_sort reorder, or what the return is.

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?

A single twelve-word sentence, front-loaded with the verb and resource, with the unpin case folded in rather than given its own clause. No filler.

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

Completeness3/5

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

Adequate for a two-parameter, no-output-schema tool, but it leaves the interaction with ordering siblings (write_sort, write_move) unaddressed, which is the main ambiguity an agent would face. Given how simple the tool is, that is a noticeable but not severe gap.

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

Parameters3/5

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

Schema coverage is 50%: page is documented in-schema as "Page id or path" while pinned has no schema description. The description's "or unpin it" partially compensates by implying pinned=true pins and pinned=false unpins, which is genuine added meaning for the undocumented parameter.

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?

States a specific verb and resource ("Pin a page") plus the scope ("to the top of its siblings") and covers both directions of the operation (pin/unpin). An agent can distinguish this from write_favorite or write_move from the description alone, though it does not explicitly name those neighbours.

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?

No when-to-use or when-not guidance beyond the self-evident split between pinning and unpinning. Nothing tells the agent how this differs from write_sort (which presumably also affects ordering) or write_favorite (which also marks pages), so the choice between siblings is left to inference.

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