post_api_exchange_test
Test exchange API key credentials. POST /api/v2/api/exchange/test
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes |
Test exchange API key credentials. POST /api/v2/api/exchange/test
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=false, destructiveHint=false, openWorldHint=false, so the safety profile is covered. The description adds only the endpoint path and the notion that this is a validation-style operation; it does not say whether credentials are persisted, whether the test can fail in ways the agent should handle, or any rate/permission requirements.
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 short, front-loaded sentences with no filler; purpose comes first. The endpoint restatement is mildly redundant given the tool name, but it is cheap and useful.
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 and thin annotations, the agent still lacks the key fact for a test tool: what a success or failure response signals (valid vs invalid credentials, error shape). The description identifies the operation but not the outcome semantics.
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%: the required body fields publicKey and privateKey have no descriptions and 'extra' is documented only as 'Some extra value if required'. The description says only 'credentials' and never maps the inputs (exchangeId, publicKey, privateKey) or explains the exchangeId-as-number convention, so it fails to compensate for the coverage gap.
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+resource: testing exchange API key credentials, and pins the endpoint (POST /api/v2/api/exchange/test). An agent can distinguish this from post_api_exchange (create) and post_api_prediction_test (different service), though the description never names those siblings explicitly.
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 when-to-use guidance: it doesn't say to call this before/after post_api_exchange, whether it validates credentials already stored via another tool, or when to prefer post_api_prediction_test. The agent must infer the workflow entirely.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.