Skip to main content
Glama

scan_skill

Starts a scan of a skill in a public GitHub or GitLab repository and returns the skill and the queued scan. Read the scan with get_skill until its status is passed, failed, incomplete or error.

Input Schema

NameRequiredDescriptionDefault
refNoBranch, tag or commit. Optional.
urlYesThe repository URL (github.com or gitlab.com).
pathNoThe directory holding SKILL.md. Optional.
organisationNoThe organisation's URL name (slug), from list_organisations. Leave it out: a connection signed in through OAuth reaches only the one organisation the person chose at sign-in, and an API key only its own. Only a connection approved before that choice existed, which reaches several organisations, needs it.

Schema Changelog

Changes observed during successful MCP inspections.

No schema history has been recorded yet.

TDQS

A4.2/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and does disclose the key trait: the operation is asynchronous, returning a queued scan rather than a completed result, and it enumerates the terminal statuses (passed, failed, incomplete, error) that end the polling loop. It omits idempotency, permission requirements, and failure behavior on unparseable repos.

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?

Two sentences, zero waste: the first establishes the action and return value, the second gives the polling instruction. The critical information is front-loaded.

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

Completeness4/5

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

With no output schema, describing the return as 'the skill and the queued scan' plus the terminal statuses is enough for an agent to complete the start-then-poll workflow. The remaining gap is that no description explains what a scan actually inspects, which a caller may want when deciding to invoke it.

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%, so url, ref, path and organisation are already documented in the schema, including the conditional guidance for organisation. The description contributes only the constraint that the URL must point at a public GitHub or GitLab repository, which the schema also states, so 3 is the appropriate baseline.

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 ('Starts a scan of a skill'), scopes it to 'a public GitHub or GitLab repository', and names both halves of the response payload. The follow-up sentence separates this tool from get_skill, which the agent is told to use for reading results.

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?

The 'public' qualifier implicitly excludes private repositories, and the description explicitly routes result-reading to get_skill until a terminal status is reached. It stops short of stating preconditions such as authentication or what to do if a scan is already queued for the same ref.

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