Skip to main content
Glama

WillItPlug documentation

Read a WillItPlug document

read_documentation
Read-onlyIdempotent

Read the complete guide for a known document ID. Returns Markdown and its source URL. Find IDs with search_documentation or resources/list.

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": {
      "id": "<id>"
    },
    "name": "read_documentation"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesDocument ID from search_documentation.

Output Schema

NameRequiredDescriptionDefault
idYes
urlYes
titleYes
markdownYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive, and closed-world, so the safety profile is covered. The description adds that the result is Markdown plus a source URL and that retrieval is by known ID, though it says nothing about behavior for an unknown or unavailable document beyond what the enum constrains.

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?

Two short sentences with zero filler; the return shape is front-loaded and the ID-discovery pointer follows it. Nothing could be removed without losing information.

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 an output schema, full annotations, and a single enum-constrained parameter, everything an agent needs to call this correctly is present in the definition or structured fields. No material gap remains for a tool of this complexity.

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 100% and the enum already enumerates the four valid IDs, so the description's reference to a "known document ID" adds little beyond the schema. Naming search_documentation as the ID source is a small assist but not new syntax or format detail.

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 ("Read the complete guide") and scopes it to a "known document ID," which immediately separates it from the search-oriented sibling. An agent can decide between this and search_documentation without opening either schema.

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

Usage Guidelines5/5

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

Explicitly says to use this tool when the ID is already known and names two routes for discovering IDs (search_documentation, resources/list). The condition that selects this tool over the alternative is stated outright.

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