Skip to main content
Glama
Sign In
Nerdit

Nerdit

Official
by nerdit-ai
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

get_guide

Read a Nerdit agent guide to learn exact config keys, call order, and failure codes before writing a nerdit.toml or deploying. Start with the index topic.

Instructions

Read one agent guide: how to build on this machine, for this daemon version.

    Use when: before writing a ``nerdit.toml`` or deploying. Returns
    ``{topic, title, daemon_version, markdown}``: the exact keys, the order
    of calls and the failure codes. Start with ``index``.

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": {
      "topic": "<topic>"
    },
    "name": "get_guide"
  }
}

Input Schema

NameRequiredDescriptionDefault
topicYesGuide topic from ``list_guides`` (e.g. ``index``, ``app``, ``ai-job``); an unknown one is 404 ``guide.not_found`` with the valid topics in ``hint``.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.9.3

TDQS

A4.5/5.0
Behavior4/5

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

With no annotations, the description carries the disclosure burden and does so reasonably: it names the return payload fields (topic, title, daemon_version, markdown), says the content covers exact keys, call order and failure codes, and the schema documents the 404 guide.not_found path. It leaves out permission or caching behavior, but for a read-only guide fetch that is minor.

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 short sentences with the what, the when and the return shape front-loaded in that order. Nothing is padded and there is no redundant restatement of the title.

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?

A one-parameter read tool with no output schema, so the description must cover return shape — and it does, enumerating the payload fields and content guarantees. An agent has everything needed to call it and interpret the result.

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; the description earns an extra point by telling the agent to begin with topic=index, which is real guidance about how to use the single parameter rather than a restatement of it.

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 ("Read one agent guide") and adds scope that no sibling could claim: how to build on this machine for this daemon version. The mention of list_guides as the source of topics cleanly separates it from the listing tool.

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?

"Use when: before writing a nerdit.toml or deploying" gives a concrete trigger, and "Start with index" supplies a sequencing hint. It stops short of stating when this is not the right tool, but the alternative (list_guides) is implied by the topic reference.

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

Deploy Server

Other Tools