get-schema
Retrieve table structure details from MySQL databases to understand data organization and relationships for query optimization and analysis.
Instructions
Get the schema of a table
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| schemaName | Yes | The name of the schema |
Implementation Reference
- src/index.ts:89-100 (handler)Handler function for the 'get-schema' tool that extracts the schemaName from args, calls the getSchema helper, and returns the result formatted as text content.async (args) => { const schemaName = args.schemaName; const result = await getSchema(schemaName); return { content: [ { type: "text", text: JSON.stringify(result, null, 2), } ] }; }
- src/index.ts:83-83 (schema)Input schema definition using Zod for the 'schemaName' parameter of the 'get-schema' tool.schemaName: z.string().describe("The name of the schema"),
- src/index.ts:82-101 (registration)Registration of the 'get-schema' tool using server.tool, specifying name, description, input schema, options, and handler function.server.tool("get-schema", "Get the schema of a table", { schemaName: z.string().describe("The name of the schema"), }, { title: "Get Schema", readOnlyHint: true, destructiveHint: false, }, async (args) => { const schemaName = args.schemaName; const result = await getSchema(schemaName); return { content: [ { type: "text", text: JSON.stringify(result, null, 2), } ] }; } );
- src/index.ts:58-80 (helper)Helper function that connects to the MySQL database, executes DESCRIBE query on the given schemaName (table), and returns the results or error.async function getSchema(schemaName: string) { // Create the connection to database using config (environment variables or command-line arguments) const connection = await mysql.createConnection({ host: config.host, port: config.port, user: config.user, password: config.password, database: config.database, }); try { const [results] = await connection.query( `DESCRIBE ${mysql.escapeId(schemaName)}` ); return results; } catch (err) { console.log(err); return err; } finally { connection.end(); } }