get_environment_credentials

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

With no annotations provided, the description carries the full behavioral disclosure burden. It discloses the output format, the specific variable names returned, and a notable limitation: the client secret is not available via API and the user is directed to the dashboard. This is strong transparency for a read-only credential lookup tool.

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?

Two sentences convey the action, the output format, the returned variables, and an important caveat. Every sentence earns its place, and the key purpose is front-loaded.

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 single-parameter, no-output-schema tool, the description adequately explains return values and the main limitation. It could additionally explain how to find environmentId or note that the operation is read-only, but those are minor gaps given the tool's simplicity.

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%, so the description must compensate for the sole environmentId parameter. It references 'a Scalekit environment' but never explains that the parameter is an environment ID, its expected format, or how to obtain it. The description adds little parameter-level meaning beyond what the property name and pattern already imply.

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 action ('Get API credentials') and a specific resource ('a Scalekit environment'), and further clarifies the exact return contents (SCALEKIT_ENVIRONMENT_URL, SCALEKIT_CLIENT_ID, active secret info). This clearly differentiates it from sibling tools like get_environment_details or list_environments.

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 gives clear context: this tool is for retrieving environment credentials and formatting them as a .env block. It also sets an expectation about the client secret limitation. It does not explicitly name alternatives or say when not to use it, but the purpose is specific enough that an agent can infer when it applies.

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