Get addon
northflank_get_addonGet details and status of a single addon. GET /v1/projects/{projectId}/addons/{addonId}.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| addonId | Yes | Addon id (from northflank_list_addons). | |
| projectId | Yes | Project id. |
northflank_get_addonGet details and status of a single addon. GET /v1/projects/{projectId}/addons/{addonId}.
| Name | Required | Description | Default |
|---|---|---|---|
| addonId | Yes | Addon id (from northflank_list_addons). | |
| projectId | Yes | Project id. |
Changes observed during successful MCP inspections.
Input schema / $schemaPrevious value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
readOnlyHint=true already tells the agent this is a safe, non-mutating read, and the description adds no behavioral context beyond restating that it fetches one resource. No mention of permissions, error behavior when the addon is missing, or what 'status' entails. It at least does not contradict the annotations.
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, zero filler, with the purpose stated first and the endpoint path appended as a secondary detail. Nothing needs trimming.
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 simple two-parameter read tool with full schema coverage this is close to adequate, but with no output schema the description should say more about what 'details and status' returns. As written, an agent knows what it fetches but not what shape to expect.
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 100%: addonId documents its source (northflank_list_addons) and projectId is described. The description adds no format or constraint detail beyond the schema, so the baseline 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?
States a specific verb ('Get') and resource ('addon') with scope narrowed to a single item, which separates it from the list-style siblings such as northflank_list_addons. It does not explicitly contrast itself with the other northflank_get_* tools, but the resource noun is distinctive enough that an agent can route correctly.
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 no when-to-use guidance, no prerequisites, and never names an alternative tool. The most useful hint, that addonId comes from northflank_list_addons, lives only in the schema, not the description.
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.