zia_get_static_ip
Get a single ZIA static IP by ID.
Instructions
Get a single ZIA static IP by ID.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| static_ip_id | Yes |
Get a single ZIA static IP by ID.
Get a single ZIA static IP by ID.
| Name | Required | Description | Default |
|---|---|---|---|
| static_ip_id | Yes |
Changes observed during successful MCP inspections.
v0.15.3Input schema / additionalPropertiesRemoved value: -falseInput schema / properties / static_ip_id / titleAdded value: +"Static Ip Id"Input schema / titleAdded value: +"zia_get_static_ipArguments"v0.14.0Input schema / additionalPropertiesAdded value: +falseInput schema / properties / serviceRemoved value: -{
- "default": "zia",
- "description": "The service to use.",
- "title": "Service",
- "type": "string"
-}Input schema / properties / static_ip_id / descriptionRemoved value: -"Static IP ID."Input schema / properties / static_ip_id / titleRemoved value: -"Static Ip Id"Input schema / properties / static_ip_id / typePrevious value: -"integer"New value: +"string"Input schema / titleRemoved value: -"zia_get_static_ipArguments"Output schema / (root)Previous value: -{
- "properties": {
- "result": {
- "additionalProperties": true,
- "title": "Result",
- "type": "object"
- }
- },
- "required": [
- "result"
- ],
- "title": "zia_get_static_ipOutput",
- "type": "object"
-}New value: +nullv0.12.7Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The readOnlyHint annotation already indicates a safe read operation, and the description ('Get') is consistent. No additional behavioral context (e.g., side effects, authentication needs) is provided beyond the annotation, but there is no contradiction.
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, concise sentence with no redundant words or unnecessary details. It is perfectly sized for the tool's simplicity.
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?
The tool is a simple get-by-ID operation with one parameter and no output schema. The description sufficiently conveys the purpose and input, and the returned data is implicitly the static IP object. It is adequate for the context.
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 schema has one parameter, static_ip_id, which is self-explanatory given the description's 'by ID' phrase. The description does not add further detail about the parameter, but the coverage is high, so the baseline of 3 applies.
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 action ('Get') and the resource ('single ZIA static IP') with the identifier ('by ID'), distinguishing it from list operations like zia_list_static_ips. It is specific and unambiguous.
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 implies use when a specific static IP ID is known, but it does not explicitly contrast with the list alternative or provide any when/when-not guidance. The context of sibling tools suggests the distinction, but it is not stated.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.