Skip to main content
Glama

marketplace_search_details_update_instance

Update marketplace search details via PATCH /v1/marketplaceSearchDetails/{id}. Send the required ID and a JSON:API request body to modify an existing App Store Connect marketplace search detail.

Instructions

PATCH /v1/marketplaceSearchDetails/{id} (PATCH /v1/marketplaceSearchDetails/{id}) Body shape: see OpenAPI components.schemas.MarketplaceSearchDetailUpdateRequest for the full JSON:API envelope.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesthe id of the requested resource
bodyYesJSON body. Shape: components.schemas.MarketplaceSearchDetailUpdateRequest.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.5.0

TDQS

C2.3/5.0
Behavior2/5

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

With no annotations, the description carries the full burden and fails: it doesn't state that this is a partial update, whether unspecified fields are preserved, what permissions are required, or how errors surface. The only useful bit is the pointer to components.schemas.MarketplaceSearchDetailUpdateRequest, which tells the agent where the payload shape lives but not what it means.

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?

Very short, so there is little waste, but the endpoint string is duplicated inside parentheses with no added information. It is under-specified rather than bloated; the brevity stems from missing content, not from tight editing.

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

Completeness2/5

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

This is a mutation tool with a nested JSON:API body, no annotations, and no output schema, so the description must carry substantial context. It supplies neither update semantics nor the envelope details an agent needs, leaving only an external schema reference.

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 description coverage is 100% for the two parameters, so the baseline is 3. The description repeats the schema's pointer to MarketplaceSearchDetailUpdateRequest without adding any field-level meaning, constraints, or the JSON:API envelope structure it references.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose2/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description is a restatement of the endpoint (PATCH /v1/marketplaceSearchDetails/{id}) with the path repeated twice. It names no domain object meaning beyond the URL and does not say what a 'marketplace search detail' is or what the update changes. Sibling tools like marketplace_search_details_create_instance and delete_instance are not distinguished beyond the implied HTTP verb.

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?

No when-to-use, when-not-to-use, prerequisites, or alternative guidance is provided. The only implicit signal is that PATCH means update rather than create/delete, which the tool name already conveys. An agent has no condition under which to prefer this over the sibling marketplace_search_details_create_instance or delete_instance.

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