Skip to main content
Glama
Sign In

Docstar

by io.github.swayammaheshwari
OverviewDiscussionsAdmin

get_docstar_api_docs

Read-onlyIdempotent

Browse the DocStar API reference one level at a time, when no dedicated tool on this server does what the user needs. Call it with {} for the top level: the modules (Collections, Pages, Endpoints, Published Versions, MCP Server, FAQs, Changelogs, Webhooks, URL Mappings, ...) with a short description and the endpoints they hold. Call it with path set to a module's link to see inside it, and with an endpoint's link ending in ".openapi.yml" to get that endpoint as an OpenAPI file: method, url, headers, query params, path variables, a body example and sample responses. Fetch only the level you need, and reuse what you already fetched.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get_docstar_api_docs"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathNoA link from a listing, exactly as given (e.g. "https://docs.example.com/sms/llms.txt" or ".../sms/send-sms.openapi.yml"), or just the path ("sms", "sms/send-sms.openapi.yml"). Leave it out for the top level.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, and non-destructive behavior, so the description doesn't need to re-litigate safety. It still adds real context beyond them: the per-level return shapes (module lists vs. endpoint details) and an explicit caching expectation that discourages redundant calls.

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 purpose and fallback condition come first, then the call patterns in increasing specificity. Every sentence carries operational information — no restated title, no filler — despite the description being longer than typical.

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

Completeness5/5

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

There is no output schema, and the description compensates by enumerating what each level returns: modules with short descriptions and their endpoints at the top, and method, url, headers, query params, path variables, body example and sample responses at the .openapi.yml level. For a single-parameter browse tool with full annotation coverage, nothing an agent needs is missing.

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 100%, so the baseline is 3, and the description earns above that by explaining the path semantics as a progression: omit it for the top level, pass a module link to descend, pass a '.openapi.yml' link to get a full endpoint spec. It complements rather than repeats the schema's example strings.

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?

States a specific verb and resource ('Browse the DocStar API reference one level at a time') and explicitly positions itself as the fallback for when no dedicated tool fits. That routing rule separates it from list_collections, search_docstar_docs, and the call_any_* siblings without the agent needing to open any schema.

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

Usage Guidelines4/5

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

Gives a clear when-to-use condition ('when no dedicated tool on this server does what the user needs') plus concrete call patterns for both levels and an efficiency rule ('fetch only the level you need, and reuse what you already fetched'). It stops short of naming a specific sibling such as search_docstar_docs as the preferred alternative for text search.

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

All Docstar toolsInspect
Try in Browser
Claude Code, inside the Godot 4 editorFlockbay puts an AI agent in the real Godot 4 editor: it writes GDScript, runs your game and fixes what breaks. Free, or bring your own Claude Code or Codex.flockbay.comAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources