Skip to main content
Glama
KitchenSink4AI

KitchenSink4Word

by KitchenSink4AI
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

Get Outline

get_outline
Read-only

List every heading with paragraph index and level, including style and outlineLvl overrides. Optionally detect formatted headings as inferred candidates with confidence scores.

Instructions

List every heading with its paragraph index and level. Detects Heading styles AND w:outlineLvl overrides (direct or style-inherited); detected_via names which. detect_formatted=True adds a heuristic scan for direct-formatted headings (short bold, italic or centered; numbered captions excluded): CANDIDATES with an INFERRED level and a confidence. Detecting nothing returns a note plus flat structure counts. The indices feed the location object's paragraph and outline selectors. Read-only. TOC building: academic pack.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
liveNoauto: file or live; force: live; off: refuseauto
file_pathYes
detect_formattedNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv2.2.1
    • addedInput schema / properties / live / description
      Added value: +"auto: file or live; force: live; off: refuse"
    • addedInput schema / properties / live / enum
      Added value: +[
+  "auto",
+  "force",
+  "off"
+]
  2. Changed1 schema field changedv2.0.0
    • addedInput schema / properties / detect_formatted
      Added value: +{
+  "default": false,
+  "type": "boolean"
+}
  3. Changed4 schema fields changedv1.6.1
    • addedInput schema / properties / live
      Added value: +{
+  "default": "auto",
+  "type": "string"
+}
    • addedOutput schema / properties / result / anyOf
      Added value: +[
+  {
+    "items": {},
+    "type": "array"
+  },
+  {
+    "additionalProperties": true,
+    "type": "object"
+  }
+]
    • removedOutput schema / properties / result / items
      Removed value: -{}
    • removedOutput schema / properties / result / type
      Removed value: -"array"
  4. First observedv1.2.1

TDQS

A4.4/5.0
Behavior5/5

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

With readOnlyHint=true already in annotations, the description still adds substantial behavioral context: dual detection mechanisms (Heading styles vs w:outlineLvl), the detect_formatted heuristic with INFERRED levels and confidence, the empty-result fallback (note plus flat counts), and how indices feed location selectors. No contradiction with annotations.

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 dense but every sentence earns its place — core behavior, detection nuance, edge case, downstream use. The telegraphic caps style (CANDIDATES, INFERRED) adds slight noise but doesn't waste space; it is appropriately sized for a tool with three behavioral modes.

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?

Given an existing output schema and annotations covering read-only safety, the description covers the remaining context: detection modes, heuristic behavior and confidence, empty-result fallback, and how the output feeds the location object's selectors. Nothing an agent needs to invoke the tool correctly is missing.

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 low (33%), and the description compensates for the most semantically loaded parameter: detect_formatted gains a full explanation of the heuristic scan and its output semantics. file_path is self-evident and live is already described in the schema enum, so the compensation is adequate where it matters.

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?

Opens with 'List every heading with its paragraph index and level' — a specific verb, resource, and output shape. It further distinguishes itself from siblings like get_text and find_text by detailing detection of Heading styles and w:outlineLvl overrides, so an agent can separate it from get_document_view and get_table without opening schemas.

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

Usage Guidelines3/5

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

The closing label 'TOC building: academic pack' provides a stated use case, so this is more than no guidance. However, it names no sibling alternatives and gives no when-not-to-use conditions, leaving the agent to infer when get_document_view or get_text would be a better fit.

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