Skip to main content
Glama

packagecloud MCP by usefulapi

Get repository README

packagecloud_get_readme
Read-only

The Markdown README of a repository. GET /repos/{user}/{repo}/readme.json.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
repositoryYesThe repository as "user/repo" (the fqname returned by packagecloud_list_repositories).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already cover the safety profile (readOnlyHint=true, destructiveHint=false, openWorldHint=true). The description adds the concrete API endpoint (GET /repos/{user}/{repo}/readme.json) and the Markdown return format, which is genuinely useful since there is no output schema, but it discloses nothing about errors (e.g. missing README) or auth.

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?

Two short fragments, front-loaded with what is returned. The endpoint clause is borderline redundant but does convey the exact call shape, so there is little waste.

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 one-parameter read with no output schema, the description supplies the essential missing piece (return type is Markdown) and the endpoint. It is nearly complete, with only error/auth behavior left unstated.

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 description coverage is 100% and the single 'repository' parameter is fully documented in the schema ('user/repo', fqname from list_repositories). The description adds no parameter detail beyond that, so the baseline of 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description names the resource (repository README) and its return format (Markdown), and the tool name/title establish the read verb. It does not explicitly distinguish itself from the append/create README siblings, though those are obviously mutations, so it lands at clear-but-no-differentiation.

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

Usage Guidelines2/5

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

There is no when-to-use guidance and no mention of the append_readme/create_readme alternatives in the sibling set. An agent must infer from the name alone that this is the read counterpart.

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.