Skip to main content
Glama

Pin an Artifact

pin_artifact
Idempotent

Pin an Artifact to the top of the user's own Artifacts library, the same as the Pin button there. Use it when the user asks you to pin something, so they can find it again. A pin is only for the user: it changes nothing about the Artifact and does not share it. Pinning one that is already pinned moves it to the top.

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": {
      "artifact_id": "<artifact_id>"
    },
    "name": "pin_artifact"
  }
}

Input Schema

NameRequiredDescriptionDefault
artifact_idYesThe Artifact id (art_…): the last part of its link, as in bisque.cloud/documents/art_…, /pages/art_… or /artifacts/art_….

Output Schema

NameRequiredDescriptionDefault
urlNo
titleNo
pinnedYes
artifact_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false, idempotentHint=true and destructiveHint=false, but the description adds genuinely non-obvious context: the pin "changes nothing about the Artifact and does not share it," and it is scoped to the user only — important because readOnlyHint=false could otherwise imply content mutation. It also discloses the re-pin behavior (already-pinned items move to the top). Missing are failure modes (nonexistent artifact, non-owned artifact) or permission requirements.

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?

Four short sentences, front-loaded with the action and scope, then when-to-use, then what a pin does not do, then the edge case of re-pinning. Each sentence contributes distinct information with no restatement of the schema or annotations.

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 one-parameter tool with an output schema and full annotation coverage, the description supplies the key semantic gaps: per-user scope, non-destructive effect on content, no sharing side effect, and re-pin ordering behavior. Only error/permission conditions for artifacts the user does not own are left unspecified.

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?

There is a single parameter with 100% schema description coverage, including a regex pattern and multiple link-format examples, so the schema fully carries parameter meaning. The description adds nothing about artifact_id beyond what the schema states; baseline 3 applies when the schema does the work.

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?

States a specific verb and resource ("Pin an Artifact") plus the exact scope: the user's own Artifacts library, analogous to the UI Pin button. The inverse sibling unpin_artifact is trivially distinguishable from this wording, and the description makes clear the pin affects ordering/visibility rather than content.

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

Usage Guidelines4/5

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

Gives an explicit trigger condition: "Use it when the user asks you to pin something, so they can find it again." That is a clear when-to-use. It stops short of naming the alternative (unpin_artifact) or stating exclusions such as shared/other-user artifacts, so it is not a full when/when-not treatment.

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