Skip to main content
Glama

Analyze codebase

codebase.analyze

Detects framework, router, routes, metadata, robots, sitemap, blog and business hints in a website repository to map SEO-relevant structure before a full QualityKit audit.

Instructions

Secondary: detect framework, router, routes, metadata, robots, sitemap, blog, business hints. Prefer qualitykit.audit for full audits.

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": {
      "projectRoot": "<projectRoot>"
    },
    "name": "codebase.analyze"
  }
}

Input Schema

NameRequiredDescriptionDefault
siteUrlNoCanonical site origin used only for generated metadata (not fetched)
projectRootYesAbsolute path to the website repository root

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.3.0

TDQS

B3.4/5.0
Behavior2/5

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

With no annotations supplied, the description carries the full behavioral burden and does very little with it. It never states that the operation is read-only, that it does not modify the repository, whether it is expensive/slow on large repos, or what the result looks like. The one behavioral detail present ('not fetched') lives in the siteUrl schema description, not the tool description.

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

Conciseness4/5

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

Two terse sentences with no filler; the detection list is compact and the alternative is front-loaded at the end. The leading 'Secondary:' is slightly cryptic as an opener but costs little space.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a two-parameter, read-only-looking scan with no output schema and no annotations, the enumeration of detected artifacts usefully approximates what the agent gets back. Missing is any statement about scope of access, side effects, or result shape, which matters given zero annotation coverage.

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% across only two parameters, so the schema already documents projectRoot and the siteUrl-purely-for-metadata caveat. The description adds no parameter meaning beyond that, which is acceptable at the baseline for fully documented schemas but earns no bonus.

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 uses a specific detection verb and enumerates concrete resources it extracts (framework, router, routes, metadata, robots, sitemap, blog, business hints). It also explicitly positions itself as secondary relative to qualitykit.audit, so an agent can distinguish it from that sibling without opening a schema. The odd 'Secondary:' framing is a bit of a category label rather than a purpose statement, which keeps it out of 5 territory.

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 names the alternative explicitly ('Prefer qualitykit.audit for full audits') and gives the condition that selects the alternative (full audits). What's left implicit is the positive case — when detection-only is the right choice — but the 'Secondary' framing plus the alternative name gives clear routing context.

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