Retrieve all text primitives from the active PCB editor, optionally filtered by layer and lock state. Returns an array of text primitive objects.
pcb_PrimitiveString.getAll(layer?: TPCB_LayersOfImage, primitiveLock?: boolean) -> Promise<Array> 获取所有文本 returns: 文本图元对象数组
| Name | Required | Description | Default |
|---|---|---|---|
| args | No | 按官方签名顺序排列的JSON参数数组 | |
| windowId | No | 目标EDA窗口ID；省略时使用当前活动窗口 |
Changes observed during successful MCP inspections.
v2.0.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden. It discloses that the tool returns a Promise of an array of IPCB_PrimitiveString, but does not state whether the operation is read-only, how layer or primitiveLock affect the results, or any side effects. This is minimal behavioral information.
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 very brief, consisting of a signature and a short Chinese description. It is front-loaded with the key information (function name and purpose), but lacks structured explanation of parameters or return details. Still, it is concise without redundancy.
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?
The tool has no output schema and no annotations, so the description must provide complete context. It returns a generic array of IPCB_PrimitiveString without detailing the object structure, and the optional parameters are unexplained. An agent would need additional documentation to use it correctly.
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 description lists the parameters layer and primitiveLock with type annotations in the signature, but does not explain their meaning or default behavior. The input schema's items field is empty ({}), providing no additional semantics, so the description adds only parameter names, not meaning.
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 states the tool retrieves all text primitives ('获取所有文本'), and the function signature 'pcb_PrimitiveString.getAll' aligns with the tool name. It distinguishes itself from sibling get_all tools through the 'string' resource type, though it doesn't explicitly contrast it with them.
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?
There is no guidance on when to use this tool versus alternatives. The description only provides a signature and return type, with no mention of filtering conditions, layer usage, or relationship to other primitive get_all functions.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.