Skip to main content
Glama

The replacement map of a website scan

get_replacement_mapping
Read-onlyIdempotent

What replaces what: one entry per original asset with original_url, original_path, replacement_path, package_file, sizes, replacement_status (ready, proposed, keep_original, rejected) and the pages that use it. Paged. Act only on entries that are ready; the files themselves are in the scan's ZIP (get_website_scan gives the address). To change a project's files, use the local server's tools (load_replacement_package, preview_replacements, apply_replacements), which ask the person first. Reads only.

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": {
      "scan_id": "<scan_id>"
    },
    "name": "get_replacement_mapping"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoDefault 100.
offsetNo
scan_idYesThe scan's id, from list_website_scans or the web app.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint and destructiveHint=false, so the safety profile is covered, yet the description still adds real context: paging behavior, the meaning of the four status values, and the operational rule to act only on `ready` entries. The trailing 'Reads only' merely restates the annotation, which keeps it from a 5, but overall the behavioral disclosure is well above the annotation baseline.

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?

The first sentence front-loads what the tool returns and its fields, then paging, then the operational constraints and alternatives follow in a logical order. It is dense but every clause is load-bearing except the final 'Reads only', which duplicates the annotations and could be dropped.

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?

There is no output schema, so the description carries the return-value burden itself and does so by enumerating the fields and the status enum. For a three-parameter read tool with full annotation coverage, an agent has everything needed: what comes back, how it is paged, which entries are actionable, and where to go for the files or for write operations.

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 67%: scan_id's provenance ('from list_website_scans or the web app') and limit's default are already in the schema, while offset is undocumented. The description contributes only the word 'Paged', with no page-size limit, offset semantics, or ordering guidance beyond what the schema states, so this sits at the expected 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?

The description opens with a concrete definition of the returned map ('one entry per original asset') and enumerates the exact fields (original_url, original_path, replacement_path, package_file, sizes, replacement_status, pages). That level of specificity lets an agent distinguish it from siblings like get_website_scan (the scan itself) and list_website_assets (raw assets), which is exactly what a purpose statement should do.

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?

It names the condition for acting on results ('Act only on entries that are ready'), explains where the actual files live (the scan's ZIP, addressed by get_website_scan), and explicitly routes mutation work to the local server tools (load_replacement_package, preview_replacements, apply_replacements). That covers when to use it, the downstream dependency, and the alternatives to use instead for writes.

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.

Resources