Skip to main content
Glama
softwareone-platform

Adobe VIP Marketplace Docs MCP Server

Rebuild VIPMP structured index

rebuild_vipmp_index
Idempotent

Rebuild the cached API documentation index by scanning all sitemap pages, ensuring endpoint, error code, and schema tools return fresh data after sitemap updates or stale results.

Instructions

Rebuild the pre-extracted index of endpoints, error codes, status codes, and schemas by walking every page in the current sitemap. Saves to ~/.cache/swo-adobe-vipm-docs-mcp/index.json.

Run this if:

  • The structured tools (list_vipmp_endpoints, list_vipmp_error_codes, get_vipmp_schema) are returning stale data

  • You just ran refresh_vipmp_sitemap and want the structured tools to pick up new pages

  • The package-shipped baseline index is older than you'd like

Takes ~60 seconds from cold cache, ~15-20 seconds from warm cache.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.17.0
  2. Removedv0.13.1
  3. First observedv0.9.0

TDQS

A4.9/5.0
Behavior5/5

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

The description discloses the actual side effect—writing to a specific cache file path—and the performance profile (60s cold, 15-20s warm). This goes beyond the annotations by explaining why readOnlyHint is false and what the idempotent rebuild actually does.

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 front-loaded with the core action, followed by tightly scoped bullets and a timing note. Every sentence earns its place, and the structure makes the when-to-use guidance easy to scan.

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?

For a zero-parameter tool with an output schema, the description covers what it does, why an agent would run it, how long it takes, and what it modifies. No critical operational detail is missing.

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?

The tool has zero parameters and 100% schema coverage, so there is no parameter semantics to add. The baseline for a zero-parameter tool is 4; the description appropriately contains no irrelevant parameter details.

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 uses a specific verb and resource: rebuild the pre-extracted index of endpoints, error codes, status codes, and schemas by walking the sitemap. It clearly identifies what the tool produces and where it saves the result, distinguishing it from related sitemap and cache tools.

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?

The 'Run this if' section explicitly lists the three concrete conditions for using the tool, including stale structured data, after refreshing the sitemap, and when the baseline index is outdated. It gives clear decision criteria with no ambiguity.

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