Skip to main content
Glama

pin_knowledge

Pin a knowledge entry as important — pinned entries appear first in the start_working briefing

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pinnedYestrue = pin, false = unpin
projectIdYesProject ID
knowledgeIdYesKnowledge entry ID

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior4/5

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

With no annotations, the description carries the behavioral burden. It goes beyond 'pin' by disclosing the persistent user-visible effect (entries appear first in the start_working briefing), which tells the agent the operation changes ordering, not just metadata. It does not discuss permissions or failure modes, but for a simple boolean pin toggle the key behavior is stated.

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 sentence that front-loads the action and packs the meaningful behavioral consequence after the em dash. No filler, no repetition of the schema.

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 three-parameter boolean toggle with all parameters documented and no nested objects or output schema, the description plus schema is enough to invoke it correctly. The only small gap is not stating explicitly that pinned=false reverses the effect, though the schema already conveys that.

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 description coverage is 100%; projectId, knowledgeId, and pinned are already documented in the schema. The description adds the real-world effect of pinned but no additional parameter-level meaning, so the baseline 3 applies.

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?

The description opens with a specific verb and resource ('Pin a knowledge entry') and defines the intent ('as important') plus a concrete consequence: pinned entries appear first in the start_working briefing. This clearly distinguishes it from sibling knowledge tools like set_knowledge_relevance or link_knowledge.

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 briefing-order effect implies when this tool is useful, but the description never says 'use this when...' or contrasts it with alternatives such as set_knowledge_relevance. An agent can infer usage but gets no explicit routing guidance.

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