Skip to main content
Glama

set_paragraph_shading

Set background shading on a paragraph by specifying its ID, fill color as a 6-digit hex code, and an optional pattern.

Instructions

Set background shading on a paragraph.

Args: para_id: paraId of the target paragraph. fill_color: Fill color as 6-digit hex (e.g., "FFFF00"). pattern: Shading pattern (default "clear").

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
para_idYes
fill_colorYes
patternNoclear

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior3/5

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

No annotations are present, so the description must convey behavioral traits. It explains the effect (set shading) and parameter formats but does not mention side effects, idempotency, or whether existing shading is overwritten.

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 extremely concise, front-loading the purpose in one sentence, then listing parameters in a clear arg format. Every sentence adds value.

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 shading tool with an output schema, the description covers all necessary information: purpose, required parameters, and default behavior. No additional details are needed.

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?

The input schema has 0% description coverage, so the description adds critical meaning: it explains para_id as the paragraph identifier, fill_color as 6-digit hex with example, and pattern with default value. This compensates for the schema's lack of descriptions.

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 tool sets background shading on a paragraph, specifying the target (para_id) and the parameters. It distinguishes from sibling tools like set_cell_shading that operate on different elements.

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?

The description does not provide any guidance on when to use this tool versus alternatives, nor does it mention prerequisites or limitations. It only describes what it does.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/SecurityRonin/docx-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server