Get IM configuration

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

The readOnlyHint annotation already establishes the safety profile, and the description adds value beyond it by enumerating the returned config domains (总开关、鉴权方式、多端登录、撤回时长、漫游、群聊、聊天室、圈组、回调、安全通、推送). That partial disclosure of return content is meaningful since no output schema exists, though it doesn't state whether all fields are always returned or how large the payload is.

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 well-formed sentence that leads with the action and resource before listing fields. Efficient with no filler; the enumeration is dense but each item adds scope information.

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?

With no output schema, the description is the only source for return content, and it does provide a field-domain overview. However, it omits how the app parameter resolves, whether results are app-wide or default-app, and any note on response shape/size, leaving gaps for a zero-coverage schema.

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?

There is one optional parameter (app) with 0% schema description coverage, so the description must carry it, and it only indirectly implies app-scoping via '应用'. It does not explain the expected app identifier format or what happens when app is omitted.

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 specific verb (读取/get) and resource (应用完整的 IM 配置) and enumerates the config domains covered, which clearly distinguishes it from the sibling yunxin_im_config_update (the mutating counterpart). It is clear what the agent gets, though it doesn't explicitly contrast with yunxin_app_get.

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?

Usage is only implied: the tool is described as reading the full IM config, and the presence of yunxin_im_config_update in the sibling list hints this is the read variant. There is no explicit when-to-use/when-not-to-use statement or guidance on choosing between this and yunxin_app_get for overlapping app data.

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