Skip to main content
Glama

style_list

Read-onlyIdempotent

List styles in a Word document by ID, name, type, parent, and usage count. Filter by type or used-only to find styles to clean up or reuse.

Instructions

List the styles defined in the document with id, name, type, parent and how many times each is used in the body. type keeps one kind (paragraph, character, table, numbering); used_only drops unused ones. Use it to find styles to clean up or reuse; style.get gives one style's full and inherited formatting. Read-only; paged: about 8,000 bytes per reply (limit up to 1,000), continue with cursor set to the reply's next.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
docYesPath to the .docx.
typeNoOnly this kind of style.
limitNoMost items to return; a response is also capped at about 8,000 bytes.
cursorNoThe `next` value of the previous response, to continue the list.
used_onlyNoOnly styles used at least once.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
okYesAlways true on success.
opYesThe operation that ran.
apiYesAPI version (1.0).
docNoThe document read or written: path, sha256 and paragraph count.
nextYesCursor for the next page (pass as cursor), or null.
resultYesWhat the operation returns.
warningsYesThings to know about the result.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.7.2
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "api": {
      +      "description": "API version (1.0).",
      +      "type": "string"
      +    },
      +    "doc": {
      +      "description": "The document read or written: path, sha256 and paragraph count.",
      +      "properties": {
      +        "characters": {
      +          "description": "text.normalize of a text string: its length.",
      +          "type": "integer"
      +        },
      +        "paragraphs": {
      +          "description": "Body paragraphs.",
      +          "type": "integer"
      +        },
      +        "path": {
      +          "description": "Path of the document.",
      +          "type": "string"
      +        },
      +        "sha256": {
      +          "description": "sha256 of the file (pass as expect.sha256 to a write).",
      +          "type": "string"
      +        },
      +        "source": {
      +          "description": "A .txt/.md/.odt source's format, encoding and split mode; \"text\" for a text string (text.normalize).",
      +          "type": [
      +            "object",
      +            "string"
      +          ]
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "next": {
      +      "description": "Cursor for the next page (pass as cursor), or null.",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "ok": {
      +      "description": "Always true on success.",
      +      "type": "boolean"
      +    },
      +    "op": {
      +      "description": "The operation that ran.",
      +      "type": "string"
      +    },
      +    "result": {
      +      "description": "What the operation returns.",
      +      "properties": {
      +        "styles": {
      +          "description": "This page of styles.",
      +          "items": {
      +            "description": "A style.",
      +            "properties": {
      +              "based_on": {
      +                "description": "Parent style id.",
      +                "type": "string"
      +              },
      +              "custom": {
      +                "description": "True for a user-defined style.",
      +                "type": "boolean"
      +              },
      +              "default": {
      +                "description": "True for the default style of its type.",
      +                "type": "boolean"
      +              },
      +              "id": {
      +                "description": "Style id (w:styleId).",
      +                "type": "string"
      +              },
      +              "name": {
      +                "description": "Display name.",
      +                "type": "string"
      +              },
      +              "type": {
      +                "description": "paragraph, character, table or numbering.",
      +                "type": "string"
      +              },
      +              "used": {
      +                "description": "Uses in the body.",
      +                "type": "integer"
      +              }
      +            },
      +            "type": "object"
      +          },
      +          "type": "array"
      +        },
      +        "total": {
      +          "description": "Items in the whole list, across pages.",
      +          "type": "integer"
      +        }
      +      },
      +      "required": [
      +        "total",
      +        "styles"
      +      ],
      +      "type": "object"
      +    },
      +    "warnings": {
      +      "description": "Things to know about the result.",
      +      "items": {
      +        "type": "string"
      +      },
      +      "type": "array"
      +    }
      +  },
      +  "required": [
      +    "api",
      +    "ok",
      +    "op",
      +    "result",
      +    "warnings",
      +    "next"
      +  ],
      +  "type": "object"
      +}
  2. Addedv0.1.3

TDQS

A4.6/5.0
Behavior5/5

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

Annotations already declare readOnlyHint, idempotentHint and the closed-world profile, so the safety story is set. The description adds genuinely new behavioral context: pagination size (~8,000 bytes/reply), the limit ceiling (1,000), and how to continue with `cursor` set to the reply's `next`.

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?

Front-loaded with the list purpose, then parameters, then routing and paging. Every sentence carries weight, though the field enumeration (id, name, type, parent, count) overlaps with the existing output schema.

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 read-only list tool with an output schema and full annotation coverage, nothing an agent needs to call it correctly is missing. Pagination, filtering, alternatives and the return-shape gist are all present.

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%, so every parameter is already documented. The description restates the semantics of `type` (one kind) and `used_only` (drops unused) but adds no syntax or interaction detail beyond the schema, 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 (list) and resource (styles defined in the document) and enumerates the returned fields. It explicitly distinguishes itself from the sibling style.get, which returns one style's full and inherited formatting.

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?

Gives a concrete use case (find styles to clean up or reuse) and names the alternative (style.get) with the condition that selects it. Both when-to-use and when-not-to-use are covered.

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