Skip to main content
Glama
Sign In

docket

by rocks.docket
OverviewDiscussionsAdmin

Read a help article

get_doc
Read-onlyIdempotent

One of docket's help articles in full, as Markdown, by its slug (from search_docs).

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": {
      "slug": "<slug>"
    },
    "name": "get_doc"
  }
}

Input Schema

NameRequiredDescriptionDefault
slugYes
languageNoen or de; default the user's language

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and openWorldHint=false, so the safety profile is covered. The description usefully adds that the response is the complete article rendered as Markdown, which is behavioral context the annotations do not provide.

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 resource identity, then format, then the key and its origin. Nothing is redundant and nothing essential is dropped.

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?

For a two-parameter read tool with no output schema, the description covers what is fetched, in what format, and where the required identifier comes from. Default language behavior is carried by the schema's own description, so no gap remains.

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

Parameters4/5

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

Schema coverage is 50%: the 'language' parameter is documented in-schema with its enum and default, but 'slug' has no schema description. The description compensates by explaining that the slug identifies the article and comes from search_docs, giving the parameter real semantics.

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 resource (a help article), the scope of the return ('in full'), the format ('as Markdown'), and the lookup key ('by its slug'). It also distinguishes itself from the sibling search_docs by framing that tool as the source of the slug rather than an alternative.

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?

The parenthetical '(from search_docs)' tells an agent it must first call search_docs to obtain a slug, which is a real prerequisite. It does not explicitly state when-not to use this tool or cover the language fallback, so it stops short of full routing guidance.

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

All docket toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources