Skip to main content
Glama
Sign In

AI Developer Toolkit documentation

by io.github.mjaskolski
OverviewDiscussionsAdmin

Search the documentation

search
Read-only

Search the AI Developer Toolkit documentation: 1100+ guides on Cursor, Claude Code and OpenAI Codex, covering setup, agent workflows, hooks, MCP, testing, CI and deployment, in English and Polish. Returns at most 10 ranked results, each with a short snippet rather than the article text; an empty list means the corpus has nothing on the topic. Pass a result id to fetch for the full text.

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": {
      "query": "<query>"
    },
    "name": "search"
  }
}

Input Schema

NameRequiredDescriptionDefault
queryYesNatural-language query or keywords. Polish queries return Polish articles.

Output Schema

NameRequiredDescriptionDefault
resultsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • removedInput schema / properties / llm_model
      Removed value: -{
-  "description": "The exact model identifier you (the assistant) are running as, taken from your system prompt or environment (e.g. \"claude-opus-4-8\", \"gpt-5.2\"). Used for analytics only. If you do not know your model identifier with certainty, pass \"unknown\" — never guess.",
-  "type": "string"
-}
    • changedInput schema / required
      Previous value: -[
-  "query",
-  "llm_model"
-]New value: +[
+  "query"
+]
  2. Changed2 schema fields changed
    • addedInput schema / properties / llm_model
      Added value: +{
+  "description": "The exact model identifier you (the assistant) are running as, taken from your system prompt or environment (e.g. \"claude-opus-4-8\", \"gpt-5.2\"). Used for analytics only. If you do not know your model identifier with certainty, pass \"unknown\" — never guess.",
+  "type": "string"
+}
    • changedInput schema / required
      Previous value: -[
-  "query"
-]New value: +[
+  "query",
+  "llm_model"
+]
  3. First observed

TDQS

A4.7/5.0
Behavior5/5

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

Annotations only declare readOnlyHint=true and openWorldHint=false; the description goes well beyond by disclosing result cardinality (at most 10), ranking, and that each hit is a short snippet rather than article text. The empty-result semantics and the fetch handoff add behavioral context an agent cannot get from annotations.

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?

Three sentences, front-loaded with corpus scope, then result shape, then the fetch handoff. Every sentence carries information the agent needs; nothing is repeated from annotations.

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?

Even though an output schema exists and return values needn't be explained, the description's snippet-vs-full-text note prevents an agent from expecting article bodies. For a single-parameter read-only search with one sibling, nothing needed for correct invocation is missing.

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 already documents the natural-language/keyword form and the Polish-query behavior. The description restates the language coverage but adds no syntax, format, or constraint detail beyond the schema, so it sits at the high-coverage baseline.

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 (search the AI Developer Toolkit documentation) plus concrete scope: 1100+ guides on Cursor, Claude Code and Codex, covering named topic areas, in English and Polish. It also names the sibling tool `fetch` and how the two relate, so an agent can place it without opening either schema.

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

Usage Guidelines5/5

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

Explicitly routes the agent: use `search` to find candidates, then 'Pass a result id to `fetch` for the full text.' It also defines the outcome boundary – 'an empty list means the corpus has nothing on the topic' – which tells the agent when to stop rather than retry.

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

All AI Developer Toolkit documentation toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources