Skip to main content
Glama
Sign In
Specky

Specky

by gbb-acelerators
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

Generate Onboarding Guide

sdd_generate_onboarding

Generate a developer onboarding guide for a feature, including overview, architecture, getting started steps, key concepts, and file locations. The guide is saved to docs/onboarding-{feature}.md.

Instructions

Generates a developer onboarding guide with feature overview, architecture summary, getting started steps, key concepts, and file locations. Writes to docs/onboarding-{feature}.md.

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": {
      "feature_number": "<feature_number>"
    },
    "name": "sdd_generate_onboarding"
  }
}

Input Schema

NameRequiredDescriptionDefault
spec_dirNoSpec directory..specs
feature_numberYesZero-padded feature number.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv3.4.0-rc.14

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already indicate not read-only and not destructive. The description adds that it writes to a specific file path, implying a side effect, but does not disclose overwrite behavior or permissions. Minimal additional context beyond 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?

The description is concise (two sentences) and front-loaded with the tool's purpose and output. Every word adds value with no redundancy.

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?

Given the tool's low complexity (2 params, no output schema), the description covers the core functionality and output location. However, it lacks details on input sources (e.g., whether it requires an existing spec) and file handling behavior.

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% with clear descriptions for both parameters. The tool description adds no extra semantic meaning beyond the schema, so baseline score of 3 is appropriate.

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?

The description clearly states that the tool generates a developer onboarding guide with specific content (feature overview, architecture summary, etc.) and writes to a file. It distinguishes itself from sibling tools like sdd_generate_docs and sdd_generate_runbook by specifying its unique output.

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives, nor any prerequisites or conditions. Siblings like sdd_generate_docs and sdd_generate_runbook exist but no differentiation is given.

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