Skip to main content
Glama

set_environment

Configure arcpy geoprocessing environment settings like workspace, extent, cell size, and overwriteOutput to control how tools run in an ArcGIS Pro session.

Instructions

Set arcpy geoprocessing environment settings such as workspace, outputCoordinateSystem, extent, mask, cellSize, overwriteOutput or parallelProcessingFactor.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
settingsYesEnvironment name/value pairs, e.g. {"overwriteOutput": true, "workspace": "D:/data/project.gdb"}.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.1.1

TDQS

B3.1/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full burden. It says 'set' but does not disclose whether settings persist for the session, whether they merge with or replace existing values, whether they affect only subsequent geoprocessing calls, or whether any authentication/permission applies. These are meaningful gaps for a global-state mutation.

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?

A single front-loaded sentence with no filler; the example list is dense but earned. It could be marginally tighter, but nothing is wasted.

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?

An output schema exists, so return values need not be explained, and parameters are covered. However, for a state-changing tool with zero annotations, the behavioral scope (persistence, merging, effect timing) is not complete enough to let an agent use it confidently.

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 100% and the single settings object is documented, but the description adds genuine value by enumerating valid environment names (workspace, outputCoordinateSystem, extent, mask, cellSize, overwriteOutput, parallelProcessingFactor) beyond the schema's one example. It does not, however, explain value formats for each key.

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?

States a specific verb (Set) and resource (arcpy geoprocessing environment settings) with concrete examples of the settings controlled. It is distinguishable from the sibling get_environment by the verb, though the description never explicitly contrasts the two.

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 or what alternatives exist (e.g. get_environment for reading, execute_arcpy_code for direct env calls). The agent must infer that this affects subsequent geoprocessing runs rather than being told.

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