@jessejoris/mcp-mysql-via-api 1.0.0

package/dist/tools/toolDefinitions.js

@@ -0,0 +1,725 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TOOL_DEFINITIONS = void 0;
+/**
+ * Complete catalog of MCP tools exposed to AI Agents (Hermes, OpenClaw, Cursor, Claude, etc.)
+ */
+exports.TOOL_DEFINITIONS = [
+    // --- Discovery Tools ---
+    {
+        name: "list_databases",
+        description: "Lists all available MySQL databases accessible via the remote API.",
+        inputSchema: {
+            type: "object",
+            properties: {},
+        },
+    },
+    {
+        name: "list_tables",
+        description: "Lists all tables in the specified or default database.",
+        inputSchema: {
+            type: "object",
+            properties: {
+                database: {
+                    type: "string",
+                    description: "Optional: database name to list tables from",
+                },
+            },
+        },
+    },
+    {
+        name: "read_table_schema",
+        description: "Returns the schema for a specific table including columns, data types, nullability, default values, primary keys, and indexes.",
+        inputSchema: {
+            type: "object",
+            properties: {
+                table_name: {
+                    type: "string",
+                    description: "The name of the table to inspect",
+                },
+                database: {
+                    type: "string",
+                    description: "Optional: database name",
+                },
+            },
+            required: ["table_name"],
+        },
+    },
+    {
+        name: "get_database_summary",
+        description: "Provides a high-level summary of all tables, approximate row counts, column types, and foreign key relationships.",
+        inputSchema: {
+            type: "object",
+            properties: {
+                database: {
+                    type: "string",
+                    description: "Optional: database name",
+                },
+                max_tables: {
+                    type: "number",
+                    description: "Optional: maximum tables to summarize (default: 50, max 200)",
+                },
+                include_relationships: {
+                    type: "boolean",
+                    description: "Optional: include foreign key relationships (default: true)",
+                },
+            },
+        },
+    },
+    {
+        name: "get_schema_erd",
+        description: "Generates a Mermaid.js ER diagram representing tables and foreign key relationships.",
+        inputSchema: {
+            type: "object",
+            properties: {
+                database: {
+                    type: "string",
+                    description: "Optional: database name",
+                },
+            },
+        },
+    },
+    {
+        name: "get_schema_rag_context",
+        description: "🎯 AI-OPTIMIZED: Returns ultra-compact schema information (tables, columns, keys, relationships, row estimates) designed specifically for LLM context windows (Hermes AI, OpenClaw, IDEs). Use keyword_filter for concept-focused schema discovery.",
+        inputSchema: {
+            type: "object",
+            properties: {
+                database: {
+                    type: "string",
+                    description: "Optional: database name",
+                },
+                max_tables: {
+                    type: "number",
+                    description: "Optional: maximum tables to include (default: 50, max: 200)",
+                },
+                max_columns: {
+                    type: "number",
+                    description: "Optional: maximum columns per table (default: 15, max: 100)",
+                },
+                keyword_filter: {
+                    type: "string",
+                    description: "Optional: concept keyword to filter relevant tables",
+                },
+            },
+        },
+    },
+    {
+        name: "get_all_tables_relationships",
+        description: "Extracts all foreign key relationships between tables in the database.",
+        inputSchema: {
+            type: "object",
+            properties: {
+                database: {
+                    type: "string",
+                    description: "Optional: database name",
+                },
+            },
+        },
+    },
+    {
+        name: "search_schema",
+        description: "Searches for matching keywords across table names and column names.",
+        inputSchema: {
+            type: "object",
+            properties: {
+                query: {
+                    type: "string",
+                    description: "Search keyword to locate in tables or column names",
+                },
+                database: {
+                    type: "string",
+                    description: "Optional: database name",
+                },
+            },
+            required: ["query"],
+        },
+    },
+    {
+        name: "find_tables_by_keyword",
+        description: "Fast keyword lookup to find relevant tables by domain concept (e.g. 'order', 'user', 'invoice').",
+        inputSchema: {
+            type: "object",
+            properties: {
+                keyword: {
+                    type: "string",
+                    description: "Keyword to search for",
+                },
+                database: {
+                    type: "string",
+                    description: "Optional: database name",
+                },
+                limit: {
+                    type: "number",
+                    description: "Maximum results (default: 20)",
+                },
+            },
+            required: ["keyword"],
+        },
+    },
+    {
+        name: "search_data_across_tables",
+        description: "🔍 Guarded read-only keyword scan across text-like column values across tables. Discovers which table contains specific values or IDs when table structure is unknown.",
+        inputSchema: {
+            type: "object",
+            properties: {
+                keyword: {
+                    type: "string",
+                    description: "Keyword or value to search across tables",
+                },
+                tables: {
+                    type: "array",
+                    items: { type: "string" },
+                    description: "Optional list of tables to search within",
+                },
+                database: {
+                    type: "string",
+                    description: "Optional: database name",
+                },
+                max_tables: {
+                    type: "number",
+                    description: "Maximum tables to scan (default: 20, max: 100)",
+                },
+                limit_per_table: {
+                    type: "number",
+                    description: "Maximum rows returned per table (default: 5, max: 50)",
+                },
+            },
+            required: ["keyword"],
+        },
+    },
+    // --- CRUD Tools with Default Pagination and Bypass ---
+    {
+        name: "read_records",
+        description: "Queries rows from a table with filters/conditions, sorting, column selection, and PAGINATION. By default, results are paginated (page=1, limit=50). Set bypass_pagination=true (or all=true) to retrieve all rows without pagination.",
+        inputSchema: {
+            type: "object",
+            properties: {
+                table_name: {
+                    type: "string",
+                    description: "Table name to query",
+                },
+                columns: {
+                    type: "array",
+                    items: { type: "string" },
+                    description: "Optional list of columns to retrieve",
+                },
+                filters: {
+                    type: "array",
+                    items: {
+                        type: "object",
+                        properties: {
+                            field: { type: "string" },
+                            operator: {
+                                type: "string",
+                                description: "Comparison operator: =, !=, <>, >, >=, <, <=, LIKE, IN, NOT IN, IS NULL, IS NOT NULL, BETWEEN, or legacy eq, neq, gt, gte, lt, lte, like, in",
+                            },
+                            value: {},
+                            secondValue: {},
+                        },
+                        required: ["field", "operator"],
+                    },
+                    description: "Optional filter clauses (alias: conditions)",
+                },
+                conditions: {
+                    type: "array",
+                    description: "Optional filter conditions (alias for filters)",
+                },
+                sorting: {
+                    type: "object",
+                    properties: {
+                        field: { type: "string" },
+                        direction: { type: "string", enum: ["asc", "desc", "ASC", "DESC"] },
+                    },
+                    required: ["field", "direction"],
+                    description: "Optional order by clause",
+                },
+                pagination: {
+                    type: "object",
+                    properties: {
+                        page: { type: "number", description: "Page number (1-based, default: 1)" },
+                        limit: { type: "number", description: "Rows per page (default: 50, max: 500)" },
+                    },
+                    description: "Pagination controls",
+                },
+                bypass_pagination: {
+                    type: "boolean",
+                    description: "Set to TRUE to bypass pagination and fetch the entire dataset (up to MAX_BYPASS_LIMIT)",
+                },
+                all: {
+                    type: "boolean",
+                    description: "Alias for bypass_pagination: true",
+                },
+                database: {
+                    type: "string",
+                    description: "Optional: database name",
+                },
+            },
+            required: ["table_name"],
+        },
+    },
+    {
+        name: "read_record",
+        description: "Fetches a single record by primary key or ID from a table via API. Fast direct point lookup.",
+        inputSchema: {
+            type: "object",
+            properties: {
+                table_name: {
+                    type: "string",
+                    description: "Table name to query",
+                },
+                id: {
+                    description: "Primary key value or record ID",
+                },
+                key_column: {
+                    type: "string",
+                    description: "Optional primary key column name (auto-detected if omitted)",
+                },
+                database: {
+                    type: "string",
+                    description: "Optional: database name",
+                },
+            },
+            required: ["table_name", "id"],
+        },
+    },
+    {
+        name: "count_records",
+        description: "Returns the total number of records in a table matching optional filter criteria.",
+        inputSchema: {
+            type: "object",
+            properties: {
+                table_name: {
+                    type: "string",
+                    description: "Table name",
+                },
+                filters: {
+                    type: "array",
+                    description: "Optional filter clauses (or conditions)",
+                },
+                conditions: {
+                    type: "array",
+                    description: "Alias for filters",
+                },
+                database: {
+                    type: "string",
+                    description: "Optional: database name",
+                },
+            },
+            required: ["table_name"],
+        },
+    },
+    {
+        name: "create_record",
+        description: "Inserts a single new record into a table. Requires 'create' permission.",
+        inputSchema: {
+            type: "object",
+            properties: {
+                table_name: {
+                    type: "string",
+                    description: "Table name",
+                },
+                data: {
+                    type: "object",
+                    description: "Object containing column-value pairs to insert",
+                },
+                database: {
+                    type: "string",
+                    description: "Optional: database name",
+                },
+            },
+            required: ["table_name", "data"],
+        },
+    },
+    {
+        name: "bulk_insert",
+        description: "Inserts multiple new records into a table in a single batch. Requires 'create' permission.",
+        inputSchema: {
+            type: "object",
+            properties: {
+                table_name: {
+                    type: "string",
+                    description: "Table name",
+                },
+                records: {
+                    type: "array",
+                    items: { type: "object" },
+                    description: "Array of record objects to insert",
+                },
+                database: {
+                    type: "string",
+                    description: "Optional: database name",
+                },
+            },
+            required: ["table_name", "records"],
+        },
+    },
+    {
+        name: "update_record",
+        description: "Updates records in a table matching filter criteria. Requires 'update' permission.",
+        inputSchema: {
+            type: "object",
+            properties: {
+                table_name: {
+                    type: "string",
+                    description: "Table name",
+                },
+                data: {
+                    type: "object",
+                    description: "Column-value pairs to update",
+                },
+                filters: {
+                    type: "array",
+                    description: "Filter clauses to specify which rows to update (cannot be empty for safety)",
+                },
+                conditions: {
+                    type: "array",
+                    description: "Alias for filters",
+                },
+                database: {
+                    type: "string",
+                    description: "Optional: database name",
+                },
+            },
+            required: ["table_name", "data"],
+        },
+    },
+    {
+        name: "bulk_update",
+        description: "Updates multiple records using their primary key column. Requires 'update' permission.",
+        inputSchema: {
+            type: "object",
+            properties: {
+                table_name: {
+                    type: "string",
+                    description: "Table name",
+                },
+                records: {
+                    type: "array",
+                    items: { type: "object" },
+                    description: "Records containing the key_column and fields to update",
+                },
+                key_column: {
+                    type: "string",
+                    description: "Primary key or unique column name",
+                },
+                database: {
+                    type: "string",
+                    description: "Optional: database name",
+                },
+            },
+            required: ["table_name", "records", "key_column"],
+        },
+    },
+    {
+        name: "delete_record",
+        description: "Deletes records from a table matching filter criteria. Requires 'delete' permission.",
+        inputSchema: {
+            type: "object",
+            properties: {
+                table_name: {
+                    type: "string",
+                    description: "Table name",
+                },
+                filters: {
+                    type: "array",
+                    description: "Filter clauses specifying which rows to delete (cannot be empty)",
+                },
+                conditions: {
+                    type: "array",
+                    description: "Alias for filters",
+                },
+                database: {
+                    type: "string",
+                    description: "Optional: database name",
+                },
+            },
+            required: ["table_name"],
+        },
+    },
+    {
+        name: "bulk_delete",
+        description: "Deletes multiple records matching a list of primary keys. Requires 'delete' permission.",
+        inputSchema: {
+            type: "object",
+            properties: {
+                table_name: {
+                    type: "string",
+                    description: "Table name",
+                },
+                key_column: {
+                    type: "string",
+                    description: "Primary key column name",
+                },
+                keys: {
+                    type: "array",
+                    items: {},
+                    description: "Array of key values to delete",
+                },
+                database: {
+                    type: "string",
+                    description: "Optional: database name",
+                },
+            },
+            required: ["table_name", "key_column", "keys"],
+        },
+    },
+    // --- Data Analysis Tools ---
+    {
+        name: "get_column_statistics",
+        description: "Returns detailed statistical analysis for a specific column: total rows, non-null count, null percentage, distinct count, min/max values, and top frequent values. Essential for data profiling.",
+        inputSchema: {
+            type: "object",
+            properties: {
+                table_name: {
+                    type: "string",
+                    description: "Table name",
+                },
+                column_name: {
+                    type: "string",
+                    description: "Column name to analyze",
+                },
+                database: {
+                    type: "string",
+                    description: "Optional: database name",
+                },
+            },
+            required: ["table_name", "column_name"],
+        },
+    },
+    // --- Query Management Tools ---
+    {
+        name: "run_select_query",
+        description: "Executes a read-only SELECT SQL query via API. Supports pagination (default page=1, limit=50) and bypass_pagination=true (or all=true). Requires 'read' permission.",
+        inputSchema: {
+            type: "object",
+            properties: {
+                query: {
+                    type: "string",
+                    description: "SQL SELECT query to execute",
+                },
+                params: {
+                    type: "array",
+                    description: "Optional parameterized query values",
+                },
+                page: {
+                    type: "number",
+                    description: "Page number (default: 1)",
+                },
+                limit: {
+                    type: "number",
+                    description: "Rows per page (default: 50, max: 500)",
+                },
+                bypass_pagination: {
+                    type: "boolean",
+                    description: "Set to TRUE to return the entire result set without pagination",
+                },
+                all: {
+                    type: "boolean",
+                    description: "Alias for bypass_pagination",
+                },
+                database: {
+                    type: "string",
+                    description: "Optional: database name",
+                },
+            },
+            required: ["query"],
+        },
+    },
+    {
+        name: "execute_write_query",
+        description: "Executes an INSERT, UPDATE, or mutation SQL query via API. Requires 'execute' permission (and 'delete' if query contains DELETE, 'ddl' if query contains DDL).",
+        inputSchema: {
+            type: "object",
+            properties: {
+                query: {
+                    type: "string",
+                    description: "SQL mutation statement to execute",
+                },
+                params: {
+                    type: "array",
+                    description: "Optional parameterized query values",
+                },
+                database: {
+                    type: "string",
+                    description: "Optional: database name",
+                },
+            },
+            required: ["query"],
+        },
+    },
+    // --- Schema DDL Tools ---
+    {
+        name: "create_table",
+        description: "Creates a new table via API. Requires 'ddl' permission.",
+        inputSchema: {
+            type: "object",
+            properties: {
+                table_name: {
+                    type: "string",
+                    description: "New table name",
+                },
+                columns: {
+                    type: "array",
+                    items: {
+                        type: "object",
+                        properties: {
+                            name: { type: "string" },
+                            type: { type: "string" },
+                            nullable: { type: "boolean" },
+                            defaultValue: {},
+                            autoIncrement: { type: "boolean" },
+                            primaryKey: { type: "boolean" },
+                        },
+                        required: ["name", "type"],
+                    },
+                    description: "Array of column definitions",
+                },
+                primary_key: {
+                    description: "Primary key column name or array of column names",
+                },
+                database: {
+                    type: "string",
+                    description: "Optional: database name",
+                },
+            },
+            required: ["table_name", "columns"],
+        },
+    },
+    {
+        name: "alter_table",
+        description: "Modifies an existing table (add column, drop column, change column) via API. Requires 'ddl' permission.",
+        inputSchema: {
+            type: "object",
+            properties: {
+                table_name: {
+                    type: "string",
+                    description: "Target table name",
+                },
+                action: {
+                    type: "string",
+                    enum: ["add_column", "drop_column", "modify_column"],
+                    description: "DDL alteration type",
+                },
+                column_definition: {
+                    type: "object",
+                    description: "Column details (name, type, nullable, etc.)",
+                },
+                database: {
+                    type: "string",
+                    description: "Optional: database name",
+                },
+            },
+            required: ["table_name", "action", "column_definition"],
+        },
+    },
+    {
+        name: "drop_table",
+        description: "Drops an existing table via API. Requires 'ddl' permission.",
+        inputSchema: {
+            type: "object",
+            properties: {
+                table_name: {
+                    type: "string",
+                    description: "Table to drop",
+                },
+                if_exists: {
+                    type: "boolean",
+                    description: "Whether to include IF EXISTS (default: true)",
+                },
+                database: {
+                    type: "string",
+                    description: "Optional: database name",
+                },
+            },
+            required: ["table_name"],
+        },
+    },
+    {
+        name: "execute_ddl",
+        description: "Executes raw DDL statement (CREATE, ALTER, DROP, TRUNCATE) via API. Requires 'ddl' permission.",
+        inputSchema: {
+            type: "object",
+            properties: {
+                query: {
+                    type: "string",
+                    description: "Raw DDL query",
+                },
+                database: {
+                    type: "string",
+                    description: "Optional: database name",
+                },
+            },
+            required: ["query"],
+        },
+    },
+    // --- Utility & Diagnostic Tools ---
+    {
+        name: "test_connection",
+        description: "Pings the remote MySQL API server and validates connectivity, latency, and credentials.",
+        inputSchema: {
+            type: "object",
+            properties: {},
+        },
+    },
+    {
+        name: "describe_connection",
+        description: "Returns the active API endpoint, server status, permission policies, and pagination defaults.",
+        inputSchema: {
+            type: "object",
+            properties: {},
+        },
+    },
+    {
+        name: "list_all_tools",
+        description: "Returns a live catalog of all available tools, their permission requirements, and active enabled/blocked status for AI agents.",
+        inputSchema: {
+            type: "object",
+            properties: {},
+        },
+    },
+    {
+        name: "export_table_to_csv",
+        description: "Exports records from a table into standard CSV format via API.",
+        inputSchema: {
+            type: "object",
+            properties: {
+                table_name: {
+                    type: "string",
+                    description: "Table to export",
+                },
+                limit: {
+                    type: "number",
+                    description: "Max rows to export (default: 1000)",
+                },
+                database: {
+                    type: "string",
+                    description: "Optional: database name",
+                },
+            },
+            required: ["table_name"],
+        },
+    },
+    {
+        name: "export_query_to_csv",
+        description: "Exports results of a SELECT query into standard CSV format via API.",
+        inputSchema: {
+            type: "object",
+            properties: {
+                query: {
+                    type: "string",
+                    description: "SELECT query to export",
+                },
+                limit: {
+                    type: "number",
+                    description: "Max rows to export (default: 1000)",
+                },
+                database: {
+                    type: "string",
+                    description: "Optional: database name",
+                },
+            },
+            required: ["query"],
+        },
+    },
+];