Skip to main content
Glama

Read Alshhbaa Brassware Developer Docs

read_docs
Read-only

Read Alshhbaa Brassware API, auth, pricing, OpenAPI, llms.txt, agent skills, and MCP developer documentation.

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": {
      "path": "<path>"
    },
    "name": "read_docs"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYesDocumentation path to read (e.g. "/openapi.json", "/auth.md", "/developers").

Output Schema

NameRequiredDescriptionDefault
contentYes
structuredContentNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, so safety is covered. The description adds the surface area of available docs but says nothing about whether access requires auth, whether responses are cached or rate-limited, or what form content comes back in; with an output schema present, the return-format gap is acceptable.

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?

A single front-loaded sentence with no filler; the only weakness is that the comma-separated topic list is slightly redundant with the enum values it mirrors.

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, enum-constrained read tool with an output schema and readOnly annotation, the definition covers enough for correct invocation. A note on how the enum paths relate to the listed topics would make it fully self-sufficient.

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% and the single parameter is a closed enum with its own example, so the schema carries the semantics. The description's topic list loosely maps to some enum values (pricing, auth, OpenAPI, llms.txt) but adds no syntax, defaults, or selection logic beyond that.

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?

States a specific verb (read) and resource (Alshhbaa Brassware developer documentation) with the topical scope enumerated. It is clear what the tool returns, though the relationship to the only sibling, search_products, is not addressed (they are in different domains, so the risk of confusion is low).

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?

Usage is implied by the topic list — an agent can infer it should call this to fetch API/auth/pricing/OpenAPI docs — but there is no explicit when/when-not guidance, no mention that the path must be one of the enumerated values, and no instruction on choosing the right path for a given need.

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