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, canonical URL and the version it describes (latest unless version selects an earlier one). 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).

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_board"
  }
}

Input 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.
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. Changed3 schema fields changed
    • 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."
      +}
    • addedOutput schema / anyOf
      Added value: +[
      +  {
      +    "oneOf": [
      +      {
      +        "additionalProperties": false,
      +        "properties": {
      +          "board": {
      +            "type": "string"
      +          },
      +          "found": {
      +            "const": false
      +          },
      +          "message": {
      +            "type": "string"
      +          },
      +          "suggestions": {
      +            "items": {
      +              "additionalProperties": false,
      +              "properties": {
      +                "board": {
      +                  "type": "string"
      +                },
      +                "name": {
      +                  "type": "string"
      +                },
      +                "url": {
      +                  "type": "string"
      +                }
      +              },
      +              "required": [
      +                "board",
      +                "name",
      +                "url"
      +              ],
      +              "type": "object"
      +            },
      +            "type": "array"
      +          }
      +        },
      +        "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"
      +          },
      +          "remix": {
      +            "additionalProperties": true,
      +            "properties": {
      +              "available": {
      +                "type": "boolean"
      +              },
      +              "fix": {
      +                "type": "string"
      +              },
      +              "reason": {
      +                "type": "string"
      +              },
      +              "webUrl": {
      +                "type": "string"
      +              }
      +            },
      +            "required": [
      +              "available",
      +              "reason",
      +              "fix",
      +              "webUrl"
      +            ],
      +            "type": "object"
      +          },
      +          "remixOf": {
      +            "anyOf": [
      +              {
      +                "type": "null"
      +              },
      +              {
      +                "additionalProperties": false,
      +                "properties": {
      +                  "board": {
      +                    "type": "string"
      +                  },
      +                  "latestVersion": {
      +                    "type": [
      +                      "integer",
      +                      "null"
      +                    ]
      +                  },
      +                  "name": {
      +                    "type": "string"
      +                  },
      +                  "state": {
      +                    "const": "available"
      +                  },
      +                  "url": {
      +                    "type": "string"
      +                  },
      +                  "version": {
      +                    "type": "integer"
      +                  }
      +                },
      +                "required": [
      +                  "state",
      +                  "board",
      +                  "name",
      +                  "url",
      +                  "version"
      +                ],
      +                "type": "object"
      +              },
      +              {
      +                "additionalProperties": false,
      +                "properties": {
      +                  "state": {
      +                    "const": "unavailable"
      +                  },
      +                  "version": {
      +                    "type": "integer"
      +                  }
      +                },
      +                "required": [
      +                  "state",
      +                  "version"
      +                ],
      +                "type": "object"
      +              },
      +              {
      +                "additionalProperties": false,
      +                "properties": {
      +                  "state": {
      +                    "const": "lookup_failed"
      +                  }
      +                },
      +                "required": [
      +                  "state"
      +                ],
      +                "type": "object"
      +              }
      +            ]
      +          },
      +          "saveCount": {
      +            "type": "integer"
      +          },
      +          "slug": {
      +            "type": "string"
      +          },
      +          "stars": {
      +            "type": "integer"
      +          },
      +          "unavailableHistoricalMetadata": {
      +            "items": {
      +              "type": "string"
      +            },
      +            "type": "array"
      +          },
      +          "updatedAt": {
      +            "type": "string"
      +          },
      +          "url": {
      +            "type": "string"
      +          },
      +          "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": [
      +          "found",
      +          "handle",
      +          "slug",
      +          "name",
      +          "version",
      +          "capabilities",
      +          "fileCount",
      +          "downloadCount",
      +          "saveCount",
      +          "createdAt",
      +          "updatedAt",
      +          "url"
      +        ],
      +        "type": "object"
      +      }
      +    ],
      +    "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 / oneOf
      Removed 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
    • 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"
      +  }
      +]
  3. 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."
  4. First observed

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already cover read-only, idempotent, open-world and non-destructive, so the description goes further by disclosing the authorisation model (read:own for non-public personal boards, read:org plus current board permission for organisation boards). It also explains that results echo the version read and that the id can be passed back to stay pinned, which is real behavioral context. It stops short of describing pagination or the exact README truncation policy, so not a 5.

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 accepted input forms, then permissions, then returns, then sibling routing – a sensible order with no filler. The return-value sentence is a long dense list that could be tightened, especially since an output schema already exists.

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?

Covers everything an agent needs to call it correctly: input forms, permission prerequisites, default versioning behavior, and where to go for design data. Return values are spelled out at a high level, with the output schema carrying the rest.

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 baseline is 3; the description still adds value by tying the 'board' argument to permission scopes and to discovery via search_boards/list_my_boards, and by clarifying the version default ('latest unless version selects an earlier one') and the round-trip of the echoed id. It does not add format/parsing detail beyond what the schema already states.

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 (Read) plus the resource (a named board), and explicitly enumerates the three accepted reference forms (handle, boardrepo.com URL, or a result from search_boards/list_my_boards). It also delineates what the tool is not for by routing design questions to read_schematic, read_pcb, get_bom and list_board_files.

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 explicit alternatives with the conditions selecting them: use read_schematic for wiring, read_pcb for copper, get_bom for parts, list_board_files + read_file for source. It also adds a guardrail ('Do not invent references'), pushing the agent to resolve handles via the search/list tools first.

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.