Skip to main content
Glama

Export N2

export_n2
Idempotent

Generate a standalone N2 diagram as an HTML file in the problem directory without opening a browser, so OpenMDAO model structure can be visualized from stored problems.

Instructions

Write a standalone N2 diagram (HTML) into the problem directory without opening a browser.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "problem_id": "<problem_id>"
    },
    "name": "export_n2"
  }
}

Input Schema

NameRequiredDescriptionDefault
titleNo
outfileNon2.html
problem_idYes

Output Schema

NameRequiredDescriptionDefault
pathNo
errorNo
size_bytesNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.1/5.0
Behavior3/5

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

Annotations only supply idempotentHint=true, so the description does useful work by disclosing the side effect (a file written into the problem directory) and that no browser is launched. It does not say whether an existing file is overwritten, what happens if the directory is missing, or how the default filename is chosen.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single front-loaded sentence with no filler; the key action and the key qualifier ('without opening a browser') both land immediately.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists, so return values need no explanation, and the tool's core behavior is stated. However, for a file-writing tool with three undocumented parameters, the definition should cover overwrite semantics and the meaning of title/outfile.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description carries the burden and largely fails: problem_id, outfile, and title are never explained. Only 'HTML into the problem directory' indirectly gestures at the outfile, leaving the title parameter and the problem_id format completely undocumented.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

Specific verb+resource: 'Write a standalone N2 diagram (HTML)' into the problem directory. It also implicitly distinguishes itself from any interactive/browser-rendering export with 'without opening a browser'. It stops short of naming a sibling, but the operation is unambiguous.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no explicit when-to-use statement, no prerequisites, and no named alternative. The phrase 'without opening a browser' hints at a contrasting capability but never routes the agent to a condition or another tool.

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