Retrieves Altium project overview data: sheet hierarchy, variants, PCB documents, parameters, and component/net counts. Use it to inspect a project's structure and totals without Altium Designer.
Overview: sheet hierarchy, variants, PCB docs, project parameters, component/net counts.
| Name | Required | Description | Default |
|---|---|---|---|
| project | Yes |
Changes observed during successful MCP inspections.
v0.1.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full behavioral burden. It indicates this is an informational read by listing returned data, but it does not state permissions, side effects, response size, or format.
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?
The description is a single front-loaded sentence with no wasted wording. It efficiently lists the return contents.
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 annotations and no output schema, the description should clarify both usage and the project parameter. It lists return categories but leaves the required parameter semantics and access behavior undocumented.
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?
The sole required parameter, project, has 0% schema description coverage and is not explained in the description. The agent cannot tell whether it expects a project ID, name, or path.
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 clearly identifies the resource and enumerates the information returned (sheet hierarchy, variants, PCB docs, project parameters, component/net counts). It lacks a verb and does not explicitly differentiate itself from siblings such as pcb_info or list_projects, but the purpose is still clear.
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?
It gives no guidance on when to use this tool versus alternatives like pcb_info, get_bom, or list_projects. The content list implies it is an overview tool, but there are no explicit usage conditions or exclusions.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.