Skip to main content
Glama
Sign In
io.github.Xvvln/pdf-reader-mcp

io.github.Xvvln/pdf-reader-mcp

by Xvvln
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

get_pdf_outline

Extract the table of contents or bookmarks from a PDF file, returning a hierarchical outline with page numbers.

Instructions

获取PDF的书签/目录结构（大纲）。

Args: file_path: PDF文件的完整路径

Returns: 包含以下信息的字典: - has_outline: 是否有目录 - outline_count: 目录条目数量 - outline: 目录列表，每个元素包含: - level: 层级(1开始) - title: 标题 - page: 页码

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": {
      "file_path": "<file_path>"
    },
    "name": "get_pdf_outline"
  }
}

Input Schema

NameRequiredDescriptionDefault
file_pathYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.1

TDQS

A3.7/5.0
Behavior3/5

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

With no annotations, the description carries full burden. It details return values (has_outline, outline_count, outline with level, title, page) but does not mention error handling, file existence prerequisites, or that it is a read-only operation.

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?

The description is concise with a clear purpose line and structured Args/Returns sections. However, it could be more succinct by removing redundant Chinese/English phrasing.

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?

Given the tool's simplicity, the description adequately explains the return format. However, it lacks information on error conditions (e.g., invalid file) and performance considerations, which would be expected for a file processing tool.

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 0%, but the description adds the parameter meaning: 'full path of PDF file'. This compensates for the lack of schema descriptions and adds context beyond the parameter name.

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?

The description clearly states the verb 'get' and the resource 'PDF bookmark/outline structure', making it distinct from sibling tools like get_pdf_info or read_pdf_as_text.

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

Usage Guidelines2/5

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

No guidance on when to use this tool versus alternatives, such as comparing with get_pdf_info for other PDF properties. The description only explains what the tool does, not the context of use.

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

Deploy Server

Other Tools