Skip to main content
Glama

solidtime_public_report

Read-only

Retrieve a Solidtime public report using the share secret from a shareable link's hash fragment, sent as the API key.

Instructions

Get a public report by share secret. GET /api/v1/public/reports with X-Api-Key set to the hash fragment of shareable_link. Auth is optional.

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": {
      "share": "<share>"
    },
    "name": "solidtime_public_report"
  }
}

Input Schema

NameRequiredDescriptionDefault
shareYesPublic share secret. Use the hash fragment of shareable_link (the part after #). Sent as X-Api-Key.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already declare readOnly/openWorld/non-destructive, and the description goes further by disclosing the HTTP verb, the exact auth header (X-Api-Key) and that authentication is optional — non-obvious behavior for a read operation. It does not mention rate limits, error behavior for an invalid/expired secret, or what the report contains, so it stops short of full disclosure.

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 dense sentence, front-loaded with purpose before endpoint and auth details. Every clause carries information, though the endpoint string is somewhat redundant with what an agent needs to know to call the tool.

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

Completeness3/5

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

For a one-parameter read tool with full schema coverage and clear annotations, the description covers invocation adequately. With no output schema, however, the agent has no idea what a returned report looks like or what fields to expect, and nothing about failure modes for an invalid secret is given.

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 schema property already explains that the secret is the hash fragment sent as X-Api-Key. The description restates that same mapping, adding consistency but no new meaning such as accepted formats, expiry, or whether the leading '#' should be included.

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 and resource ("Get a public report") plus the keying mechanism ("by share secret"), and gives the underlying endpoint GET /api/v1/public/reports, which clarifies this is the unauthenticated public route rather than the internal one. It does not name the sibling tool solidtime_reports, so the agent must infer that distinction from the URL and the word "public".

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?

Conveys the key precondition implicitly (you need a share secret, derived from the shareable link's hash fragment) and notes auth is optional, which is the main trigger condition for using this route. It never explicitly says when to prefer this over solidtime_reports or what to do when no share secret exists, leaving the choice to inference.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.