Skip to main content
Glama

AILANG onboarding guide

onboarding_guide
Read-onlyIdempotent

Stepwise onboarding flow for using AILANG. role: "agent" (AI coding agent flow, default) | "developer" (human dev flow) | "" (returns both) For v1 returns the full guide; client picks the relevant role. v2 may filter on AILANG side once we have proper record-projection helpers.

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": {
      "role": "<role>"
    },
    "name": "onboarding_guide"
  }
}

Input Schema

NameRequiredDescriptionDefault
roleYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare this as a safe, read-only, idempotent operation, so the safety profile is covered. The description adds genuinely useful behavior beyond that: for v1 the full guide is returned regardless of role and the client must do the filtering, which prevents an agent from assuming server-side filtering. The v2 note is more roadmap commentary than behavior.

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?

The role-value enumeration is front-loaded and efficient, but the trailing sentence about v2 and record-projection helpers is internal development commentary that does not help an agent call the tool. That clause dilutes an otherwise tight definition.

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?

With no output schema, the description does state what comes back (the full guide for the requested role or both), which is the key missing piece an agent would otherwise have to guess. Nothing about permissions, errors, or size/pagination is mentioned, but for a static documentation fetch that is a minor gap.

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 0% and the single required 'role' parameter is an undescribed plain string, so the description carries the full burden. It does that well by enumerating all three accepted values with their meanings, including the counterintuitive empty string that returns both flows. It does not state whether values are case-sensitive or what happens with an unrecognized value, keeping it below 5.

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 first sentence names a specific resource and shape ('stepwise onboarding flow for using AILANG'), which is clear enough for an agent to know this returns guidance content rather than performing an action. It does not explicitly differentiate itself from nearby siblings like install_guide or docs_nav, so it stops short of a 5.

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?

The description effectively tells the agent how to choose the role value, including the default ('agent') and the empty-string case that returns both flows. However, there is no guidance on when to call this tool versus install_guide, docs_nav, or docs_search, leaving cross-tool selection to inference.

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.