uipath_get_jobs

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

With no annotations provided, the description carries the full burden. It discloses a folderId requirement, which is useful, but it fails to clarify key behavioral aspects like whether this is a read-only operation (though implied by 'Get'), what happens if folderId is omitted, pagination behavior (despite a limit parameter), or the structure of the returned data. The vague 'most operations' adds ambiguity.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single sentence that front-loads the action, includes the key optional filters, and adds a critical prerequisite. There is zero waste; every word earns its place.

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

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

For a list-style read tool with full schema coverage, the description is minimally viable but leaves gaps. It does not explain the return format, mention pagination or default limit, distinguish from similar job-related tools, or clarify operational prerequisites beyond folderId. Given the presence of many sibling tools and no output schema, more context would be helpful.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so all parameters are documented in the schema. The description mentions 'state or process name', which maps to the 'state' and 'releaseName' parameters, but adds no additional meaning or format details beyond what the schema already provides. This is an exact baseline scenario.

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

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

The description clearly states the tool retrieves jobs from UiPath Orchestrator with optional filtering by state or process name, which is a specific verb+resource+scope. It distinguishes itself somewhat from siblings like get_job_details or get_faulted_jobs by the mention of filtering, but it does not explicitly contrast with them.

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

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

The description provides a prerequisite ('Requires folderId for most operations') but gives no guidance on when to use this tool versus alternatives such as uipath_get_job_details or uipath_get_faulted_jobs. There is no mention of exclusions or preferred scenarios, leaving the agent without clear selection criteria.

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