Skip to main content
Glama

Ownware Catalogue

Read a product quickstart

quickstart
Read-only

The QUICKSTART file that ships inside the product, verbatim — how to install and run it. Returns nothing when that product ships none.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
slugYesThe product slug.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, so the tool is known to be non-destructive. The description adds a behavioral detail: 'Returns nothing when that product ships none', which is useful context about the tool's output under a specific condition. However, it does not disclose other behaviors like error handling or format details, but with the annotation covering safety, this is sufficient for a baseline score.

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?

The description is concise, comprising two short sentences with no redundant wording. The core purpose is front-loaded, and the note about returning nothing is an efficient addition. Every sentence earns its place with minimal filler.

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 simple read-only tool with one parameter and no output schema, the description covers the essential aspects: what it returns (the quickstart file verbatim) and the edge case when no file exists. It does not specify pagination or formatting, but these are likely not relevant for this tool. Minor gaps like error handling for invalid slugs are not critical, so the description is nearly complete.

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?

The schema fully describes the 'slug' parameter as 'The product slug', so parameter semantics are already covered structurally. The description does not add any additional meaning to the parameter beyond what the schema provides. Given 100% schema coverage, a baseline score of 3 is appropriate.

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?

The description clearly states it reads the QUICKSTART file that ships inside the product, specifying the exact content ('how to install and run it'). The verb 'read' plus resource 'quickstart file' is specific, and it differentiates from sibling tools (checkout_link, hosted_offer, product, search_catalogue) which serve other purposes.

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 implies when to use the tool—when you need the product's quickstart file—but does not explicitly state when to prefer it over alternatives. There is no mention of when not to use it or comparison with siblings like 'product' or 'search_catalogue'. The use case is inferable but not 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