Skip to main content
Glama
Sign In
arcgis-docs

arcgis-docs

by GeorgeSuarez
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

Find an ArcGIS API reference

get_api
Read-onlyIdempotent

Search ArcGIS Maps SDK for JavaScript API reference pages by class, function, or module name to find matching documentation snippets for follow-up page retrieval.

Instructions

Search API reference pages for a class, function, or module name (for example MapView, FeatureLayer, geometryEngine, reactiveUtils). Returns the best reference pages with snippets; follow up with get_page.

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": {
      "symbol": "<symbol>"
    },
    "name": "get_api"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoMaximum number of references.
symbolYesClass, function, or module name.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, and openWorldHint=false, so the safety profile is covered. The description adds that results are 'the best reference pages with snippets' and that get_page is the follow-up, but says nothing about result counts, ranking behavior, or empty-result handling beyond what the schema's limit implies.

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?

Two tight sentences with the search scope and examples front-loaded and the follow-up action second. No redundant restatement of the title or schema.

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?

For a simple two-parameter read-only search with no output schema and full schema coverage, the description supplies the return shape at a high level ('reference pages with snippets') and the downstream step. Only the behavior on zero matches is unaddressed.

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%, so both parameters are already documented and the baseline is 3. The description reinforces the symbol parameter with examples of valid inputs, but adds nothing for limit and no format hints beyond the schema.

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 names a specific verb and resource ('Search API reference pages') and constrains it to a class, function, or module name, with concrete examples (MapView, FeatureLayer, geometryEngine, reactiveUtils). It does not explicitly contrast with the sibling search_docs, so an agent must infer that this tool is scoped to API reference rather than all docs.

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

Usage Guidelines3/5

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

It gives clear next-step guidance ('follow up with get_page') once a reference page is identified, which is genuinely useful workflow routing. However, it never states when to prefer search_docs over get_api, nor what to do if no reference page matches, leaving the primary sibling distinction implicit.

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