Skip to main content
Glama

Get a board overview

get_board
Read-onlyIdempotent

Read a named board, boardrepo.com URL, or result from search_boards or list_my_boards. Non-public personal boards require read:own; organisation boards require read:org and current board permission. Returns metadata, a bounded README excerpt, tags, license, source EDA format, detected KiCad version, capabilities, file count and canonical URL. Do not invent references. For the design, use read_schematic (schematic wiring), read_pcb (copper: vias, pads, tracks), get_bom (parts), or list_board_files then read_file (source).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
boardYesA board: handle/slug or a boardrepo.com URL. Discover public boards with search_boards, personal or authorised organisation boards with list_my_boards.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / oneOf
      Previous value: -[
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "board": {
      -        "type": "string"
      -      },
      -      "found": {
      -        "const": false
      -      },
      -      "message": {
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "found",
      -      "board",
      -      "message"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": true,
      -    "properties": {
      -      "capabilities": {
      -        "additionalProperties": false,
      -        "properties": {
      -          "bom": {
      -            "type": "boolean"
      -          },
      -          "gerbers": {
      -            "type": "boolean"
      -          },
      -          "pcb": {
      -            "type": "boolean"
      -          },
      -          "schematic": {
      -            "type": "boolean"
      -          }
      -        },
      -        "required": [
      -          "schematic",
      -          "pcb"
      -        ],
      -        "type": "object"
      -      },
      -      "createdAt": {
      -        "type": "string"
      -      },
      -      "downloadCount": {
      -        "type": "integer"
      -      },
      -      "fileCount": {
      -        "type": "integer"
      -      },
      -      "found": {
      -        "const": true
      -      },
      -      "handle": {
      -        "type": "string"
      -      },
      -      "name": {
      -        "type": "string"
      -      },
      -      "saveCount": {
      -        "type": "integer"
      -      },
      -      "slug": {
      -        "type": "string"
      -      },
      -      "updatedAt": {
      -        "type": "string"
      -      },
      -      "url": {
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "found",
      -      "handle",
      -      "slug",
      -      "name",
      -      "capabilities",
      -      "fileCount",
      -      "downloadCount",
      -      "saveCount",
      -      "createdAt",
      -      "updatedAt",
      -      "url"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "board": {
      +        "type": "string"
      +      },
      +      "found": {
      +        "const": false
      +      },
      +      "message": {
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "found",
      +      "board",
      +      "message"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": true,
      +    "properties": {
      +      "capabilities": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "bom": {
      +            "type": "boolean"
      +          },
      +          "gerbers": {
      +            "type": "boolean"
      +          },
      +          "pcb": {
      +            "type": "boolean"
      +          },
      +          "schematic": {
      +            "type": "boolean"
      +          }
      +        },
      +        "required": [
      +          "schematic",
      +          "pcb"
      +        ],
      +        "type": "object"
      +      },
      +      "createdAt": {
      +        "type": "string"
      +      },
      +      "downloadCount": {
      +        "type": "integer"
      +      },
      +      "fileCount": {
      +        "type": "integer"
      +      },
      +      "found": {
      +        "const": true
      +      },
      +      "handle": {
      +        "type": "string"
      +      },
      +      "name": {
      +        "type": "string"
      +      },
      +      "saveCount": {
      +        "type": "integer"
      +      },
      +      "slug": {
      +        "type": "string"
      +      },
      +      "stars": {
      +        "type": "integer"
      +      },
      +      "updatedAt": {
      +        "type": "string"
      +      },
      +      "url": {
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "found",
      +      "handle",
      +      "slug",
      +      "name",
      +      "capabilities",
      +      "fileCount",
      +      "downloadCount",
      +      "saveCount",
      +      "createdAt",
      +      "updatedAt",
      +      "url"
      +    ],
      +    "type": "object"
      +  }
      +]
  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. Discover public boards with search_boards, personal or authorised organisation boards with list_my_boards."
  3. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the description's reading behavior is consistent. It adds valuable context beyond annotations: the bounded README excerpt, the list of returned metadata fields, the canonical URL, and a 'do not invent references' constraint. This goes beyond what annotations alone convey, earning a 4.

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?

Three sentences, each earning its place: the first states the input scope, the second summarizes outputs and permissions, and the third routes to siblings. No redundancy, no filler, and the most important scoping info is front-loaded.

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 single-parameter, output-schema-provided, read-only tool, this description is complete. It covers how to obtain valid inputs, what permissions are needed, what the returned data includes, and which sibling to pick for deeper design details. An agent can invoke this tool correctly without external information.

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

Parameters3/5

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

Schema coverage is 100% — the `board` parameter is already fully documented as a handle/slug or boardrepo.com URL, with discovery guidance pointing to search_boards and list_my_boards. The description largely restates the accepted input forms and the permission caveat, adding no new syntax or detail beyond the schema, so it stays at the baseline 3.

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?

The description opens with 'Read a named board...' giving a specific verb and resource, and enumerates accepted input forms (named board, boardrepo.com URL, or results from search_boards/list_my_boards). It also names sibling alternatives (read_schematic, read_pcb, get_bom, list_board_files) and what each is for, so an agent can clearly differentiate this overview tool from design-specific readers.

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?

Explicit when-to-use and when-not-to-use guidance is embedded: 'For the design, use read_schematic... read_pcb... get_bom... or list_board_files then read_file.' It also states how to discover inputs via search_boards and list_my_boards, and notes permission prerequisites (read:own, read:org plus current board permission).

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.