Skip to main content
Glama

Import a GitHub repository as a board

import_github_board
Idempotent

Store a KiCad or Altium project from one of the user's own GitHub repositories as a new BoardRepo board, in the background. Use when the user asks to add, import or store a board that lives on GitHub; you do not need to read any file. The repository must be under the GitHub account linked to their BoardRepo account; a private repository needs the BoardRepo GitHub App. A public repository becomes a public board; a private one is unlisted unless visibility is private. Returns the queued job and the dashboard URL where the board appears when processing finishes; a repository already on BoardRepo returns its board URL instead. Only on the user's request.

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": {
      "repository": "<repository>"
    },
    "name": "import_github_board"
  }
}

Input Schema

NameRequiredDescriptionDefault
repositoryYesowner/name or a github.com repository URL. Only repositories under the user's linked GitHub account.
visibilityNoFor a private repository: private (account only) or private_link (unlisted, the default). A public repository is always a public board.
keepUpdatedNoPublish a new version when the default branch moves. Needs the BoardRepo GitHub App; otherwise ignored and reported.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.6/5.0
Behavior5/5

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

Adds substantial behavior beyond the annotations: the work is asynchronous ('in the background'), it returns a queued job plus a dashboard URL, and an already-imported repo returns its existing board URL rather than re-importing — reinforcing the idempotentHint with concrete semantics. It also discloses the permission requirement (GitHub App) and how visibility is derived per repository type, none of which the annotations convey.

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 action and the trigger, then constraints, then return behavior — a logical order with no filler. It is a dense paragraph rather than scannable lines, and the return-value sentence partially duplicates the output schema, which keeps it just short of a 5.

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 an async, open-world import tool this covers trigger, account/App prerequisites, visibility mapping, idempotent re-import behavior, and what the caller gets back. Nothing needed to call it correctly is missing, even though the output schema already exists.

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, but the description adds real meaning on top: 'A public repository becomes a public board; a private one is unlisted unless visibility is private' explains the interaction between repository visibility and the visibility parameter, and it notes that keepUpdated is ignored and reported when the App is absent.

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: 'Store a KiCad or Altium project ... as a new BoardRepo board, in the background.' It also scopes what is NOT involved ('you do not need to read any file'), which separates it from file-reading siblings like read_file or 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 Guidelines4/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 to add, import or store a board that lives on GitHub') plus prerequisites: repo must be under the linked GitHub account, private repos need the BoardRepo GitHub App, and it should be invoked 'Only on the user's request.' It does not name an alternative tool (e.g. push_board or commit_board_upload) for boards not on GitHub, so the exclusion is implied rather than stated.

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.

Resources