list_filesRetrieve files from the Viya Files Service. Apply a name filter to locate specific files, and set a limit to manage the number of results.
List files in the Viya Files Service.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum files to return (default 50). | |
| filter_name | No | Optional name filter (substring match). |
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |
Changes observed during successful MCP inspections.
v1.2.0Output schema / properties / result / items / additionalPropertiesAdded value: +trueOutput schema / properties / result / items / typeAdded value: +"object"v0.1.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The annotations already declare readOnlyHint, idempotentHint, and non-destructive behavior, and the description does not contradict these. However, the description adds no behavioral context beyond the basic listing action, such as pagination semantics, result ordering, or what subset of files is returned.
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 front-loaded sentence with no filler, no repetition of schema details, and no unnecessary qualifiers. Every word carries meaning.
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 simple read-only list operation with two optional parameters, the description, schema, output schema, and annotations together provide enough factual information to invoke the tool correctly. It does not offer broader context about when to prefer this over sibling file tools, but that gap is more about usage guidance than completeness of the tool definition.
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?
The input schema documents both parameters with clear descriptions: the limit default and the optional substring filter. Since schema description coverage is 100%, the description does not need to compensate, and the baseline of 3 is appropriate.
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 states a specific operation ('List files') and a specific resource scope ('Viya Files Service'), which clearly distinguishes it from sibling list tools such as list_reports or list_jobs. This is a concrete verb-resource pairing rather than a restatement of the title.
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?
No explicit when-to-use or when-not-to-use guidance is given, and no alternative tools are named. The intended use is only implied by the tool name and the one-line description, which is adequate for a unique list operation but leaves selection reasoning entirely to the agent.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.