Skip to main content
Glama

Get a board's BOM

get_bom
Read-onlyIdempotent

Use when the user asks which parts a public board uses: reference designators, quantity, value, footprint, MPN, manufacturer, DNP, and datasheet. Returns up to 200 lines per call (pass the returned cursor for more). When the board has a BOM sheet, the line's MPN, manufacturer and datasheet are what the sheet shows, and each line also carries part (its identity) and cells: MPNs, supplier codes, links, notes and custom columns people or assistants filled in, with who filled them; update_bom_cells changes them on your own boards. No prices, stock or device pinouts. Search first if the board is unknown; use read_schematic for schematic wiring and read_pcb for copper vias/pads.

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": {
      "board": "<board>"
    },
    "name": "get_bom"
  }
}

Input Schema

NameRequiredDescriptionDefault
boardYesA board: handle/slug or a boardrepo.com URL. Use search_boards for public boards or list_my_boards for personal and authorised organisation boards. Do not invent references.
cursorNoOpaque pagination cursor from a previous call; pass to fetch the next page.
versionNoWhich saved version to read: a version number (3 or "v3"), a versionId from list_board_versions, "latest", or a release tag such as "rev-A". Omit for the latest version. Results echo the version they read; pass its id back to stay on it.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changed
    • removedInput schema / properties / include_pricing
      Removed value: -{
      -  "description": "When true, add live sourcing to each line: best unit price, currency, in-stock quantity, lifecycle-risk band, and whether the price is an estimate. Pass it whenever the user asks about cost, sourcing, availability, or 'how much'. Prices come from distributors and may be partial or absent for obscure parts; this makes the call slower than the static BOM, so leave it off for a plain parts list.",
      -  "type": "boolean"
      -}
    • addedInput schema / properties / version
      Added value: +{
      +  "anyOf": [
      +    {
      +      "minimum": 1,
      +      "type": "integer"
      +    },
      +    {
      +      "maxLength": 64,
      +      "minLength": 1,
      +      "type": "string"
      +    }
      +  ],
      +  "description": "Which saved version to read: a version number (3 or \"v3\"), a versionId from list_board_versions, \"latest\", or a release tag such as \"rev-A\". Omit for the latest version. Results echo the version they read; pass its id back to stay on it."
      +}
    • removedOutput schema / additionalProperties
      Removed value: -true
    • addedOutput schema / anyOf
      Added value: +[
      +  {
      +    "additionalProperties": true,
      +    "properties": {
      +      "derivedFromPcb": {
      +        "type": "boolean"
      +      },
      +      "hasNextPage": {
      +        "type": "boolean"
      +      },
      +      "lines": {
      +        "items": {
      +          "additionalProperties": true,
      +          "properties": {
      +            "category": {
      +              "type": "string"
      +            },
      +            "qty": {
      +              "type": "integer"
      +            },
      +            "refs": {
      +              "type": "string"
      +            }
      +          },
      +          "required": [
      +            "category",
      +            "refs",
      +            "qty"
      +          ],
      +          "type": "object"
      +        },
      +        "type": "array"
      +      },
      +      "nextCursor": {
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "note": {
      +        "type": "string"
      +      },
      +      "total": {
      +        "type": "integer"
      +      },
      +      "version": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "id": {
      +            "type": "string"
      +          },
      +          "latest": {
      +            "type": "boolean"
      +          },
      +          "number": {
      +            "type": "integer"
      +          },
      +          "tags": {
      +            "items": {
      +              "type": "string"
      +            },
      +            "type": "array"
      +          }
      +        },
      +        "required": [
      +          "id",
      +          "number",
      +          "latest",
      +          "tags"
      +        ],
      +        "type": "object"
      +      }
      +    },
      +    "required": [
      +      "total",
      +      "lines",
      +      "derivedFromPcb",
      +      "hasNextPage",
      +      "nextCursor"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": true,
      +    "properties": {
      +      "appError": {
      +        "type": "string"
      +      },
      +      "bytesNeeded": {
      +        "type": "integer"
      +      },
      +      "cause": {
      +        "type": "string"
      +      },
      +      "currentHead": {
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "currentPolicyHash": {
      +        "type": "string"
      +      },
      +      "docsUrl": {
      +        "type": "string"
      +      },
      +      "fix": {
      +        "type": "string"
      +      },
      +      "freeBytes": {
      +        "type": "integer"
      +      },
      +      "issues": {
      +        "items": {
      +          "additionalProperties": false,
      +          "properties": {
      +            "message": {
      +              "type": "string"
      +            },
      +            "path": {
      +              "type": "string"
      +            },
      +            "received": {
      +              "type": "string"
      +            }
      +          },
      +          "required": [
      +            "path",
      +            "message"
      +          ],
      +          "type": "object"
      +        },
      +        "type": "array"
      +      },
      +      "message": {
      +        "type": "string"
      +      },
      +      "operationId": {
      +        "type": "string"
      +      },
      +      "projectsLeft": {
      +        "type": "integer"
      +      },
      +      "reason": {
      +        "type": "string"
      +      },
      +      "resetsAt": {
      +        "type": "string"
      +      },
      +      "retryAfterMs": {
      +        "type": "integer"
      +      },
      +      "retryable": {
      +        "type": "boolean"
      +      },
      +      "sourceSaved": {
      +        "type": "boolean"
      +      },
      +      "storedResultAvailable": {
      +        "type": "boolean"
      +      },
      +      "suggestions": {
      +        "items": {
      +          "additionalProperties": false,
      +          "properties": {
      +            "board": {
      +              "type": "string"
      +            },
      +            "name": {
      +              "type": "string"
      +            },
      +            "url": {
      +              "type": "string"
      +            }
      +          },
      +          "required": [
      +            "board",
      +            "name",
      +            "url"
      +          ],
      +          "type": "object"
      +        },
      +        "type": "array"
      +      },
      +      "uploadLinks": {
      +        "items": {
      +          "additionalProperties": false,
      +          "properties": {
      +            "bytes": {
      +              "type": "integer"
      +            },
      +            "expiresAt": {
      +              "type": "string"
      +            },
      +            "headers": {
      +              "type": "object"
      +            },
      +            "method": {
      +              "const": "PUT"
      +            },
      +            "path": {
      +              "type": "string"
      +            },
      +            "sha256": {
      +              "type": "string"
      +            },
      +            "uploadUrl": {
      +              "type": "string"
      +            }
      +          },
      +          "required": [
      +            "path",
      +            "bytes",
      +            "sha256",
      +            "uploadUrl",
      +            "method",
      +            "headers",
      +            "expiresAt"
      +          ],
      +          "type": "object"
      +        },
      +        "type": "array"
      +      },
      +      "url": {
      +        "type": "string"
      +      },
      +      "visibility": {
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "reason",
      +      "message"
      +    ],
      +    "type": "object"
      +  }
      +]
    • removedOutput schema / properties
      Removed value: -{
      -  "derivedFromPcb": {
      -    "type": "boolean"
      -  },
      -  "hasNextPage": {
      -    "type": "boolean"
      -  },
      -  "lines": {
      -    "items": {
      -      "additionalProperties": true,
      -      "properties": {
      -        "category": {
      -          "type": "string"
      -        },
      -        "qty": {
      -          "type": "integer"
      -        },
      -        "refs": {
      -          "type": "string"
      -        }
      -      },
      -      "required": [
      -        "category",
      -        "refs",
      -        "qty"
      -      ],
      -      "type": "object"
      -    },
      -    "type": "array"
      -  },
      -  "nextCursor": {
      -    "type": [
      -      "string",
      -      "null"
      -    ]
      -  },
      -  "note": {
      -    "type": "string"
      -  },
      -  "pricingIncluded": {
      -    "type": "boolean"
      -  },
      -  "total": {
      -    "type": "integer"
      -  }
      -}
    • removedOutput schema / required
      Removed value: -[
      -  "total",
      -  "lines",
      -  "pricingIncluded",
      -  "derivedFromPcb",
      -  "hasNextPage",
      -  "nextCursor"
      -]
  2. Changed1 schema field changed
    • changedInput schema / properties / board / description
      Previous value: -"A public board: handle/slug (e.g. alice/keezyboost40) or a boardrepo.com URL. Discover it with search_boards; do not invent one."New value: +"A board: handle/slug or a boardrepo.com URL. Use search_boards for public boards or list_my_boards for personal and authorised organisation boards. Do not invent references."
  3. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Beyond the readOnly/idempotent annotations it discloses the 200-line page cap and cursor continuation, that results echo the version read, how BOM-sheet values differ from computed ones, the `part`/`cells` structure with attribution, and explicit exclusions (no prices, stock, or pinouts).

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

Conciseness4/5

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

Front-loaded with the trigger and return fields, then pagination, then structure, then exclusions and alternatives — a logical order with no filler, though the single dense paragraph is longer than strictly necessary.

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

Completeness5/5

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

For a read-only, three-parameter tool with a full schema and an output schema, the description covers trigger, scope, pagination, return shape, exclusions, and sibling routing — nothing an agent needs to call it correctly is missing.

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

Parameters4/5

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

Schema coverage is 100%, so the baseline is 3; the description still adds value by explaining cursor continuation and the version-echo round-trip ('pass its id back to stay on it') and by warning not to invent board references.

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

Purpose5/5

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

States a specific verb and resource ('which parts a public board uses') and enumerates the returned fields (reference designators, quantity, value, footprint, MPN, manufacturer, DNP, datasheet), which clearly separates it from read_schematic and read_pcb.

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

Usage Guidelines5/5

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

Gives an explicit trigger ('Use when the user asks which parts a public board uses'), a prerequisite ('Search first if the board is unknown'), named alternatives for adjacent needs (read_schematic for wiring, read_pcb for copper), and the sibling that mutates the same data (update_bom_cells).

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.