Skip to main content
Glama
Sign In
OpenDocKit

OpenDocKit

by hyeonsang010716
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Local

document_outline

Read-onlyIdempotent

Summarizes a local file’s structure—format, title, size, and page, slide, or sheet titles and lengths—so you can choose which sections to convert.

Instructions

Describe a local document without returning its text: format, title, size, and its pages, slides or sheets with their numbers, titles and lengths. Use it to decide which sections to ask convert_document for.

path: the file to read (absolute, or relative to where the server was started).

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": {
      "path": "<path>"
    },
    "name": "document_outline"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.3.2

TDQS

A4.8/5.0
Behavior4/5

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

Annotations already establish read-only, idempotent, non-destructive, local behavior. The description adds useful behavioral context by saying it does not return document text and instead returns structural metadata with page/slide/sheet numbers, titles, and lengths; it does not discuss error cases, which is a minor gap.

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?

The description is short, front-loaded with the core purpose, and then gives the only parameter's special path semantics. There is no redundant wording, and the return fields are listed compactly.

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 simple one-parameter, read-only metadata tool with no output schema, the description covers the essential return shape and the path semantics. Annotations cover safety, so the definition gives enough context for correct invocation without over-explaining.

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

Parameters5/5

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

There is only one parameter, `path`, and the description compensates for the 0% schema coverage by defining it as the file to read and explaining that it may be absolute or relative to the server start location. That is exactly the semantic detail an agent needs to construct the call.

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 states a specific verb and resource: describe a local document without returning its text, and names exactly what metadata it returns (format, title, size, pages/slides/sheets). It also distinguishes the tool from convert_document by framing this as the outline step before conversion.

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?

It explicitly says to use the tool to decide which `sections` to ask `convert_document` for, giving both the purpose and the sibling workflow. The phrase 'without returning its text' further clarifies why an agent should choose this over text conversion when it only needs structure.

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