Skip to main content
Glama
rshade
by rshade

python_format

Format Python code using ruff, with an option to check for issues without modifying files.

Instructions

Format Python code using ruff format with check mode support

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
argsNoAdditional arguments
checkNoCheck without modifying files
filesNoSpecific files to format
timeoutNoCommand timeout in milliseconds
directoryNoWorking directory
Behavior3/5

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

In the absence of annotations, the description partially discloses behavior by mentioning 'check mode support', indicating that it can check without modifying. However, it does not disclose that it modifies files by default, or other behaviors like return format or side effects.

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 a single concise sentence that covers the core functionality. It is front-loaded and efficient, though a second sentence on usage could improve completeness without harming conciseness.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 5-parameter tool with no output schema and no annotations, the description is minimally sufficient. It lacks details on return values, default behavior, and required environment, which are important for effective use.

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 coverage is 100%, so the schema already documents all parameters. The description adds no extra meaning beyond echoing the 'check' parameter. Baseline of 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly identifies the tool's purpose: formatting Python code using ruff format, with check mode support. It distinguishes from siblings like python_lint by focusing on formatting, though it could benefit from explicitly contrasting with linting tools.

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 (e.g., python_lint for linting). No conditions, prerequisites, or exclusions are mentioned.

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/rshade/mcp-devtools-server'

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