Skip to main content
Glama
gakkiismywife

MCP MySQL Server

README.md
# MCP MySQL Server

This is a generated Model Context Protocol (MCP) server designed to interact with a MySQL database in a read-only fashion, providing schema inspection and custom query capabilities.

## Setup Instructions

1.  **Create a folder**: Create a new directory for your server, for example, `my-mcp-server`.

    ```bash
    mkdir my-mcp-server
    cd my-mcp-server
    ```

2.  **Save the files**: Place `package.json`, `tsconfig.json`, `index1.ts`, and `README.md` into this new directory.

3.  **Install dependencies**: Open your terminal in the `my-mcp-server` directory and run:

    ```bash
    npm install
    ```

4.  **Build the project**: Compile the TypeScript code:

    ```bash
    npm run build
    ```


## Available Tools

This server exposes the following tools:

*   **`list_tables()`**: Lists all tables in the connected MySQL database.
*   **`describe_table(tableName: string)`**: Describes the columns of a specified table.
*   **`execute_read_query(query: string, params?: any[])`**: Executes a read-only SQL query (SELECT, SHOW, DESCRIBE) against the database.

# With Cursor