Skip to main content
Glama
Sign In

pipehero

by io.github.pipehero
OverviewDiscussionsAdmin

get_api_share_link

Read-only

Get the shareable link of an endpoint (a read-only page with its docs, examples and latest run, secrets hidden), who can open it and who was invited. Use it to put the link in a PR, an issue or a message. Each endpoint has one link that never changes; shared: false means it has none yet (see share_api_endpoint).

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": {
      "collection_id": "<collection_id>"
    },
    "name": "get_api_share_link"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathNoRoute path as written in the code, e.g. /v1/charges/:id or /v1/charges/{id}.
methodNoHTTP method of the route, e.g. POST. Use with path instead of endpoint_id.
endpoint_idNoId of the endpoint. Alternative to method + path.
collection_idYesId from list_api_collections.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.4/5.0
Behavior5/5

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

Annotations already declare readOnlyHint/no-destructive, and the description does not contradict them. It adds substantive behavior beyond annotations: the page is read-only, secrets are hidden, the link is immutable ('never changes'), and `shared: false` indicates absence of a link. That is meaningful context for a read call whose return content matters.

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?

Three tightly-packed sentences, front-loaded with the core action and scoping semantics. The parenthetical is information-dense rather than wasteful, though the description is on the busier side.

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

Completeness5/5

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

With no output schema, the description carries the return-value burden and does so: it lists what the link shows and who can open/was invited, plus the stable-link guarantee. Nothing an agent needs to call or interpret this tool is missing.

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%, so all four parameters (path, method, endpoint_id, collection_id) are already documented in the schema, including the method+path vs endpoint_id alternative. The description adds no per-parameter detail, so the baseline of 3 is appropriate.

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+resource ('Get the shareable link of an endpoint') and immediately clarifies what that link is (read-only page with docs, examples, latest run). It names the sibling 'share_api_endpoint' as the counterpart, so an agent can distinguish it from related sharing tools without opening a schema.

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?

Explains the use case ('put the link in a PR, an issue or a message') and clarifies the `shared: false` state with a pointer to share_api_endpoint. It gives clear positive context but no explicit when-not-to-use guidance.

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

All pipehero toolsInspect
Try in Browser
Claude Code, inside the Godot 4 editorFlockbay puts an AI agent in the real Godot 4 editor: it writes GDScript, runs your game and fixes what breaks. Free, or bring your own Claude Code or Codex.flockbay.comAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources