Skip to main content
Glama

quickstart-docstar

Read-only

Document the user's API in DocStar, turn it into an MCP server for their product, and keep it in sync with their code (GitHub Sync). Load before any Docstar task. Call this to load the full instructions for this skill before doing the task.

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": "quickstart-docstar"
  }
}

Input Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, openWorldHint=false, so safety is covered by structured data. The description adds only that the tool returns full skill instructions, with no detail on size, format, or whether the instructions persist across turns. That is useful but thin for a tool whose entire payload is its output.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three sentences, but two of them say the same thing: "Load before any Docstar task" and "Call this to load the full instructions for this skill before doing the task" are redundant. The front-loading is also inverted — the actual tool function (loading instructions) appears last, behind an outcome statement that reads like the tool does the documentation work itself.

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 zero-parameter, read-only instruction loader with no output schema, the definition supplies the essentials: that it returns full instructions and that it must precede other Docstar work. The remaining gap — no hint about what those instructions contain or which siblings they will route to — is minor given the tool's simplicity.

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 tool takes zero parameters, so there is no parameter semantics to explain and the 100% schema coverage is trivially vacuous. A zero-param tool would normally earn the baseline 4, but the description also fails to describe the one thing that matters here — the shape of the returned instructions.

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 eventually states a specific action: "Call this to load the full instructions for this skill before doing the task," which clearly marks it as an instruction-loader rather than one of the CRUD siblings like create_page or update_endpoint. However, the opening sentence ("Document the user's API in DocStar, turn it into an MCP server...") describes the skill's outcome, not the tool's operation, so an agent skimming the first line could mistake it for a tool that actually performs documentation work.

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?

It gives an explicit positional rule: "Load before any Docstar task," which tells the agent this is a prerequisite step rather than an alternative to the sibling tools. It stops short of naming any sibling or stating what to do after loading (e.g., that the returned instructions will route to call_any_api_of_docstar or create_endpoint), but the when-to-use condition itself is unambiguous.

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