Bot API Get Bot
neuron_bot_api_get_botRetrieve configuration and status information about the bot associated with the provided API key.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| apiKey | Yes | Bot API key with 'nrn_' prefix for authentication |
neuron_bot_api_get_botRetrieve configuration and status information about the bot associated with the provided API key.
| Name | Required | Description | Default |
|---|---|---|---|
| apiKey | Yes | Bot API key with 'nrn_' prefix for authentication |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and safe behavior; description adds minimal context about retrieving configuration/status but lacks details on error handling or invalid key behavior. 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?
Single sentence, 16 words, front-loaded with verb and resource. No unnecessary words.
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?
Given the tool's simplicity (1 param, annotations present, no output schema), the description sufficiently covers what the tool does and the authentication requirement, though could elaborate on returned data scope.
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 coverage is 100% and description for apiKey is identical to schema's description, adding no new meaning. Baseline score 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?
Description uses specific verb 'Retrieve' and resource 'configuration and status information', clearly distinguishing from sibling tools like neuron_get_bot by specifying the bot is identified via API key.
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?
Description implies usage for bot API key holders but does not explicitly state when to use this tool over alternatives such as neuron_get_bot, nor provides when-not-to-use guidance.
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.