create_index_template

Instructions

Implementation Reference

• src/tools/createIndexTemplate.ts:3-64 (handler)

  The main handler function for createIndexTemplate tool. Takes esClient, name, indexPatterns, template, priority, version and calls esClient.indices.putIndexTemplate. Returns success/error response content.

  export async function createIndexTemplate(
    esClient: Client,
    name: string,
    indexPatterns: string[],
    template: Record<string, any>,
    priority?: number,
    version?: number
  ) {
    try {
      const body: Record<string, any> = {
        index_patterns: indexPatterns,
        template: {
          settings: template.settings || {},
          mappings: template.mappings || {},
          aliases: template.aliases || {}
        }
      };
  
      // Add optional parameters if provided
      if (priority !== undefined) {
        body.priority = priority;
      }
  
      if (version !== undefined) {
        body.version = version;
      }
  
      const response = await esClient.indices.putIndexTemplate({
        name,
        body
      });
  
      return {
        content: [
          {
            type: "text" as const,
            text: `Index template "${name}" created successfully.`
          },
          {
            type: "text" as const,
            text: `Index patterns: ${indexPatterns.join(", ")}`
          },
          {
            type: "text" as const,
            text: response.acknowledged 
              ? "Template was acknowledged by the cluster."
              : "Template was not acknowledged. Check cluster status."
          }
        ]
      };
    } catch (error) {
      console.error(`Create index template failed: ${error instanceof Error ? error.message : String(error)}`);
      return {
        content: [
          {
            type: "text" as const,
            text: `Error: ${error instanceof Error ? error.message : String(error)}`
          }
        ]
      };
    }
  }

• src/server.ts:226-259 (registration)

  Registration of the create_index_template tool on the MCP server using server.tool(). Defines the schema (name, indexPatterns, template, priority, version) using Zod validations and calls the handler.

  // Create or update an index template
  server.tool(
    "create_index_template",
    "Create or update an Elasticsearch index template",
    {
      name: z
        .string()
        .trim()
        .min(1, "Template name is required")
        .describe("Name of the index template"),
      
      indexPatterns: z
        .array(z.string())
        .min(1, "At least one index pattern is required")
        .describe("Array of index patterns this template applies to"),
      
      template: z
        .record(z.any())
        .describe("Template configuration including settings, mappings, and aliases"),
      
      priority: z
        .number()
        .optional()
        .describe("Optional template priority - higher values have higher precedence"),
      
      version: z
        .number()
        .optional()
        .describe("Optional template version number")
    },
    async ({ name, indexPatterns, template, priority, version }) => {
      return await createIndexTemplate(esClient, name, indexPatterns, template, priority, version);
    }
  );

• src/server.ts:13-27 (helper)

  Import and re-export of the createIndexTemplate function from the tools module.

  import { createIndexTemplate, getIndexTemplate, deleteIndexTemplate } from "./tools/createIndexTemplate.js";
  
  export { 
    listIndices, 
    getMappings, 
    search, 
    getClusterHealth, 
    createIndex, 
    createMapping, 
    bulk, 
    reindex, 
    createIndexTemplate,
    getIndexTemplate,
    deleteIndexTemplate
  }; 

• src/server.ts:230-254 (schema)

  Zod input validation schema for create_index_template: name (string), indexPatterns (string array), template (record), priority (optional number), version (optional number).

  {
    name: z
      .string()
      .trim()
      .min(1, "Template name is required")
      .describe("Name of the index template"),
    
    indexPatterns: z
      .array(z.string())
      .min(1, "At least one index pattern is required")
      .describe("Array of index patterns this template applies to"),
    
    template: z
      .record(z.any())
      .describe("Template configuration including settings, mappings, and aliases"),
    
    priority: z
      .number()
      .optional()
      .describe("Optional template priority - higher values have higher precedence"),
    
    version: z
      .number()
      .optional()
      .describe("Optional template version number")