Skip to main content
Glama
sandraschi

pdf-mcp

pdf_help

Read-only

Lists available PDF tools or returns detailed usage help for a specific tool, so you can discover and call the right function in pdf-mcp.

Instructions

List available tools and get usage help for pdf-mcp.

Return Format

A dict with keys:

  • success: bool

  • message: str - human-readable summary

  • data: list of tools with name, description, and input schema, or detailed help for a single tool when tool_name is provided.

Examples

await pdf_help() {"success": true, "message": "8 tools available.", "data": [{"name": "pdf_extract", ...}]}

await pdf_help(tool_name="pdf_extract") {"success": true, "message": "Help for pdf_extract.", "data": {...}}

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
tool_nameNoName of a tool to get detailed help for. Lists all tools if omitted.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
messageNoHuman-readable summary
successNoWhether the operation succeeded

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.1

TDQS

A4.1/5.0
Behavior4/5

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

readOnlyHint=true is consistent with a help/discovery operation, and the description goes beyond the annotation by documenting the return contract (success/message/data with tool names, descriptions, and input schemas). It does not mention latency or authentication characteristics, but for a read-only introspection tool the disclosure is solid.

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?

Purpose is front-loaded in the first sentence, followed by a compact return-format block and two concrete examples. The examples earn their place for a help tool since they demonstrate both the no-arg and arg call shapes, though the section could be trimmed slightly.

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?

An output schema exists, so return values need not be re-explained, and the annotation covers safety. The description still supplies the response shape and examples, making the definition complete for a zero-required-parameter help tool; no prerequisites or edge cases are omitted that would block correct invocation.

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% and the single parameter already documents 'Name of a tool to get detailed help for. Lists all tools if omitted.' The description restates this rather than adding syntax or format depth, 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?

States a specific verb+resource pair: lists available tools and returns usage help for the pdf-mcp server, with an optional drill-down for a single tool. It is unmistakably the meta/discovery tool, distinguishable at a glance from all named siblings like pdf_extract or pdf_export.

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 description and worked examples make the when-to-use clearly implied: call with no arguments to enumerate tools, call with tool_name for detailed help. It states the selection condition for the parameter ('Lists all tools if omitted') but does not explicitly frame when an agent should prefer this help lookup over just reading a tool's own schema.

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