Skip to main content
Glama

get-components

Returns detected open-source/CMS components for a project (all vaults) or a single vault. Provide exactly one of project_id or vault_id. Requires full data access (a paid plan; verification-only plans are not included). Requires X-API-Key (existing users can generate an API key in the web app). If headers aren't supported, pass api_key in arguments.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlNoFilter: substring match on component URL.
nameNoFilter: substring match on component name.
limitNoMax results to return (default 50, max 200).
offsetNoNumber of results to skip, for pagination.
vendorNoFilter: substring match on vendor.
api_keyNoOptional API key for clients that cannot set X-API-Key headers.
vault_idNoVault id (from create-code-vault or list_vaults). Returns data for this vault only.
project_idNoProject id (from create_project). Returns data aggregated across all vaults in the project.
sort_by_sizeNoSort by total_lines_of_code descending instead of by name.
only_outdatedNoOnly return components where current_version != latest_version.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.1/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 well: it discloses the auth mechanism (X-API-Key, with an api_key argument fallback when headers are unsupported) and an access-tier constraint (paid plan required; verification-only plans excluded). It does not state pagination behavior or the default/limit caps, but those live in the schema.

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 core purpose, then the selection constraint, then prerequisites and auth in descending priority. Every sentence carries information, though the auth/header sentence is slightly tangential to the primary call decision.

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?

For a 10-parameter read tool with no annotations and no output schema, the description covers the essentials an agent needs: what is returned, the mutually exclusive id params, access tier, and auth. It stops short of describing the return shape or sort/pagination defaults, but the schema documents those.

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 already 100%, so baseline is 3, but the description adds real meaning: it explains that project_id aggregates across all vaults while vault_id scopes to one, and it clarifies the api_key fallback beyond the schema's terse field text. The exactly-one-of constraint is duplicated from the oneOf schema and required-fields block, keeping it short of a 5.

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?

Specific verb ('Returns') plus resource ('detected open-source/CMS components') and explicit scope ('a project (all vaults) or a single vault'). This clearly distinguishes it from siblings like get-security-issues, get-code-smells, and get-contributors without needing to open the schema.

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

Usage Guidelines3/5

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

The description gives a hard selection rule ('Provide exactly one of project_id or vault_id') and a prerequisite (full data access / paid plan), but never names an alternative tool or explains when an agent should choose this over the other component-adjacent tools. Usage is implied rather than guided.

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.