Skip to main content
Glama
rishab2404

Elasticsearch MCP Server

by rishab2404
OverviewSchemaSourceRelated ServersDiscussionsAdmin
JavaScript
Hybrid

get_mappings

Retrieve field mappings for an Elasticsearch index to understand data structure and types.

Instructions

Get field mappings for a specific Elasticsearch index

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
indexYesName of the Elasticsearch index to get mappings for

Implementation Reference

  • index.ts:187-227 (handler)
    The handler function for the get_mappings tool. It fetches the mappings for the specified Elasticsearch index using esClient.indices.getMapping and returns a formatted text response with the mappings or an error message.
    async ({ index }) => {
  console.error("[DEBUG] get_mappings tool called", index);
  try {
    const mappingResponse = await esClient.indices.getMapping({
      index,
    });

    return {
      content: [
        {
          type: "text" as const,
          text: `Mappings for index: ${index}`,
        },
        {
          type: "text" as const,
          text: `Mappings for index ${index}: ${JSON.stringify(
            mappingResponse[index]?.mappings || {},
            null,
            2
          )}`,
        },
      ],
    };
  } catch (error) {
    console.error(
      `Failed to get mappings: ${
        error instanceof Error ? error.message : String(error)
      }`
    );
    return {
      content: [
        {
          type: "text" as const,
          text: `Error: ${
            error instanceof Error ? error.message : String(error)
          }`,
        },
      ],
    };
  }
}
  • index.ts:180-186 (schema)
    Input schema for the get_mappings tool, which validates that the 'index' parameter is a non-empty trimmed string.
    {
  index: z
    .string()
    .trim()
    .min(1, "Index name is required")
    .describe("Name of the Elasticsearch index to get mappings for"),
},
  • index.ts:178-228 (registration)
    Registration of the get_mappings tool using server.tool(), including name, description, input schema, and handler function.
      "get_mappings",
  "Get field mappings for a specific Elasticsearch index",
  {
    index: z
      .string()
      .trim()
      .min(1, "Index name is required")
      .describe("Name of the Elasticsearch index to get mappings for"),
  },
  async ({ index }) => {
    console.error("[DEBUG] get_mappings tool called", index);
    try {
      const mappingResponse = await esClient.indices.getMapping({
        index,
      });

      return {
        content: [
          {
            type: "text" as const,
            text: `Mappings for index: ${index}`,
          },
          {
            type: "text" as const,
            text: `Mappings for index ${index}: ${JSON.stringify(
              mappingResponse[index]?.mappings || {},
              null,
              2
            )}`,
          },
        ],
      };
    } catch (error) {
      console.error(
        `Failed to get mappings: ${
          error instanceof Error ? error.message : String(error)
        }`
      );
      return {
        content: [
          {
            type: "text" as const,
            text: `Error: ${
              error instanceof Error ? error.message : String(error)
            }`,
          },
        ],
      };
    }
  }
);

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.3/5.0
Behavior2/5

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

With no annotations, the description carries full burden but only states 'Get field mappings', implying read-only but not disclosing permissions, side effects, or behavior like error handling.

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?

Single sentence, no unnecessary words, front-loaded with the action and target.

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

Completeness3/5

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

Given no output schema, the description could mention what the response contains; it is adequate but minimal for a simple get operation.

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% and the parameter 'index' has a description; the tool description adds no extra meaning beyond what the schema provides.

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?

Description uses specific verb 'Get' and resource 'field mappings' for a specific Elasticsearch index, clearly distinguishing from siblings like create_mapping or search.

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 guidance on when to use this tool versus alternatives; for example, it doesn't explain how it differs from create_mapping or search in terms of use cases.

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