create_index
Add an index to a MySQL table to improve query performance by specifying columns, index name, and optional uniqueness constraints.
Instructions
Create an index on a table
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| table | Yes | Table name | |
| indexName | Yes | Index name | |
| columns | Yes | Column names to index | |
| unique | No | Whether this is a unique index | |
| database | No | Database name (optional) |
Implementation Reference
- src/index.ts:531-560 (handler)The asynchronous handler function that implements the logic to create an index on a specified MySQL table. It constructs and executes a CREATE INDEX SQL statement using the provided table, index name, columns, unique flag, and optional database.
async ({ table, indexName, columns, unique, database }) => { const p = await getPool(); const tableName = database ? `\`${database}\`.\`${table}\`` : `\`${table}\``; const columnList = columns.map((c) => `\`${c}\``).join(", "); const uniqueStr = unique ? "UNIQUE " : ""; await p.execute( `CREATE ${uniqueStr}INDEX \`${indexName}\` ON ${tableName} (${columnList})` ); const output = { success: true, table, indexName, columns, unique: unique || false, database: database || null, }; return { content: [ { type: "text" as const, text: `Index ${indexName} created successfully on ${table}`, }, ], structuredContent: output, }; } - src/index.ts:524-529 (schema)Zod schema for input validation of the create_index tool parameters: table, indexName, columns (array of strings), optional unique boolean, and optional database.
{ table: z.string().describe("Table name"), indexName: z.string().describe("Index name"), columns: z.array(z.string()).describe("Column names to index"), unique: z.boolean().optional().describe("Whether this is a unique index"), database: z.string().optional().describe("Database name (optional)"), - src/index.ts:521-561 (registration)The server.tool() call that registers the create_index tool, including name, description, input schema, and handler function.
server.tool( "create_index", "Create an index on a table", { table: z.string().describe("Table name"), indexName: z.string().describe("Index name"), columns: z.array(z.string()).describe("Column names to index"), unique: z.boolean().optional().describe("Whether this is a unique index"), database: z.string().optional().describe("Database name (optional)"), }, async ({ table, indexName, columns, unique, database }) => { const p = await getPool(); const tableName = database ? `\`${database}\`.\`${table}\`` : `\`${table}\``; const columnList = columns.map((c) => `\`${c}\``).join(", "); const uniqueStr = unique ? "UNIQUE " : ""; await p.execute( `CREATE ${uniqueStr}INDEX \`${indexName}\` ON ${tableName} (${columnList})` ); const output = { success: true, table, indexName, columns, unique: unique || false, database: database || null, }; return { content: [ { type: "text" as const, text: `Index ${indexName} created successfully on ${table}`, }, ], structuredContent: output, }; } );