Publish Service Definition

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

Adds meaningful behavioral context beyond the annotations: it validates an .sd digest before upload, restricts uploads to an exact whitelist, and explicitly avoids accepting or returning credentials. It does not detail overwrite effects, but annotations already cover the core mutation profile.

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?

A single front-loaded sentence with no redundant or filler content. It communicates validation, upload scope, and credential constraint efficiently.

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?

An output schema exists, so return values need not be described, and annotations cover safety hints. However, with 9 parameters and no schema descriptions, the description is too sparse to fully guide correct invocation of this high-impact publishing tool.

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 description coverage is 0% across 9 parameters. The description indirectly explains expected_sha256 ('摘要'), portal/server whitelisting, and credential handling, but leaves most parameters such as aprx_path, sharing_level, server_type, federated_server_url, and overwrite_existing_service undocumented.

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?

States a concrete action: validate the .sd digest and upload it to a whitelisted Portal/Server. The resource and target are clear, though it does not explicitly distinguish this tool from siblings such as stage_service_definition.

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?

Provides an implied precondition ('校验 .sd 摘要后') and a scope restriction ('仅向精确白名单 Portal/Server'), but does not state when to use this versus alternatives or when not to use it.

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