Skip to main content
Glama
Sign In
arcgis-docs

arcgis-docs

by GeorgeSuarez
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

Search ArcGIS Maps SDK docs

search_docs
Read-onlyIdempotent

Search locally indexed ArcGIS Maps SDK for JavaScript documentation to find relevant pages and snippets before retrieving full content.

Instructions

Full-text search over the locally indexed ArcGIS Maps SDK for JavaScript documentation. Returns titles, URLs, page kinds, scores, and snippets. Use this before 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": {
      "query": "<query>"
    },
    "name": "search_docs"
  }
}

Input Schema

NameRequiredDescriptionDefault
kindNoOptional page kind filter.
limitNoMaximum number of results.
queryYesNatural-language or keyword query, e.g. 'migrate widgets to components'.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, and closed-world, so safety is covered; the description adds real value by enumerating the returned fields (titles, URLs, page kinds, scores, snippets) in the absence of an output schema. It omits ranking behavior and whether the local index can be stale.

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?

Three short sentences, front-loaded with purpose, then return shape, then the routing hint. Nothing is redundant.

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 three-parameter search tool with full schema coverage and no output schema, the description covers purpose, return fields, and next step. It lacks only ranking/pagination or index-freshness notes that could affect result interpretation.

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% — the query example, kind enum values, and limit bounds/default are all already documented in the schema. The description adds no extra semantics such as whether kind is an AND filter or how limit interacts with scoring.

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?

States a specific verb and resource ('Full-text search over the locally indexed ArcGIS Maps SDK for JavaScript documentation') and pins the scope to a local index, which separates it from the remote/API-oriented siblings get_api and list_sources.

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?

'Use this before get_page' gives an explicit sequencing rule against one concrete alternative, which is useful for an agent deciding how to start a docs lookup. It stops short of 5 because no when-not guidance is given for get_api or list_sources (e.g., direct API symbol lookup).

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