Skip to main content
Glama
yaoxiaolinglong

MCP-MongoDB-MySQL-Server

connect_db

Establish a connection to MySQL databases using URL parameters or configuration details to enable database operations through the MCP server.

Instructions

Connect to MySQL database using URL or config

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlNoDatabase URL (mysql://user:pass@host:port/db)
workspaceNoProject workspace path
hostNo
userNo
passwordNo
databaseNo

Implementation Reference

  • The primary handler function for the 'connect_db' tool. Parses connection arguments (URL, workspace, or direct params), closes any existing connection, sets the config, ensures connection, and returns success message.
    private async handleConnectDb(args: any) {
      let config: ConnectionConfig | null = null;
    
      // Priority 1: Direct URL
      if (args.url) {
        config = this.parseConnectionUrl(args.url);
      }
      // Priority 2: Workspace config
      else if (args.workspace) {
        this.currentWorkspace = args.workspace;
        config = await this.loadWorkspaceConfig(args.workspace);
      }
      // Priority 3: Individual connection params
      else if (args.host && args.user && args.password && args.database) {
        config = {
          host: args.host,
          user: args.user,
          password: args.password,
          database: args.database
        };
      }
    
      if (!config) {
        throw new McpError(
          ErrorCode.InvalidParams,
          'No valid database configuration provided. Please provide either a URL, workspace path, or connection parameters.'
        );
      }
    
      // Close existing connection if any
      if (this.connection) {
        await this.connection.end();
        this.connection = null;
      }
    
      this.config = config;
    
      try {
        await this.ensureConnection();
        return {
          content: [
            {
              type: 'text',
              text: `Successfully connected to database ${config.database} at ${config.host}`
            }
          ]
        };
      } catch (error) {
        throw new McpError(
          ErrorCode.InternalError,
          `Failed to connect to database: ${getErrorMessage(error)}`
        );
      }
    }
  • Input schema definition for the 'connect_db' tool, specifying optional properties for URL, workspace, or individual connection parameters.
    inputSchema: {
      type: 'object',
      properties: {
        url: {
          type: 'string',
          description: 'Database URL (mysql://user:pass@host:port/db)',
          optional: true
        },
        workspace: {
          type: 'string',
          description: 'Project workspace path',
          optional: true
        },
        // Keep existing connection params as fallback
        host: { type: 'string', optional: true },
        user: { type: 'string', optional: true },
        password: { type: 'string', optional: true },
        database: { type: 'string', optional: true }
      },
      // No required fields - will try different connection methods
    },
  • src/index.ts:208-232 (registration)
    Tool registration in the ListTools response, including name, description, and input schema for 'connect_db'.
    {
      name: 'connect_db',
      description: 'Connect to MySQL database using URL or config',
      inputSchema: {
        type: 'object',
        properties: {
          url: {
            type: 'string',
            description: 'Database URL (mysql://user:pass@host:port/db)',
            optional: true
          },
          workspace: {
            type: 'string',
            description: 'Project workspace path',
            optional: true
          },
          // Keep existing connection params as fallback
          host: { type: 'string', optional: true },
          user: { type: 'string', optional: true },
          password: { type: 'string', optional: true },
          database: { type: 'string', optional: true }
        },
        // No required fields - will try different connection methods
      },
    },
  • src/index.ts:537-538 (registration)
    Dispatch registration in the CallToolRequestHandler switch statement, routing 'connect_db' calls to the handleConnectDb method.
    case 'connect_db':
      return await this.handleConnectDb(request.params.arguments);
  • Helper function to parse MySQL connection URL into config object, used by handleConnectDb.
    private parseConnectionUrl(url: string): ConnectionConfig {
      const parsed = parseUrl(url);
      if (!parsed.host || !parsed.auth) {
        throw new McpError(
          ErrorCode.InvalidParams,
          'Invalid connection URL'
        );
      }
    
      const [user, password] = parsed.auth.split(':');
      const database = parsed.pathname?.slice(1);
    
      if (!database) {
        throw new McpError(
          ErrorCode.InvalidParams,
          'Database name must be specified in URL'
        );
      }
    
      return {
        host: parsed.hostname!,
        user,
        password: password || '',
        database,
        ssl: parsed.protocol === 'mysqls:' ? { rejectUnauthorized: true } : undefined
      };
    }

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

C2.9/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden of behavioral disclosure. It states the tool connects to a database, implying it establishes a session or handle, but doesn't describe what happens after connection (e.g., persistence, timeout, error handling), authentication needs beyond parameters, or side effects. For a tool with zero annotation coverage, this is a significant gap in transparency.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is extremely concise—a single sentence that directly states the tool's purpose and method without any fluff. It's front-loaded and wastes no words, making it easy for an agent to parse quickly. Every part of the sentence earns its place by conveying essential information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (database connection with 6 parameters), lack of annotations, no output schema, and low schema description coverage, the description is incomplete. It doesn't cover behavioral aspects like connection lifecycle, error cases, or output format, leaving critical gaps for the agent to infer. This is inadequate for a tool that likely has significant operational implications.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 33% (only 'url' and 'workspace' have descriptions), so the description must compensate but adds minimal value. It mentions 'URL or config', hinting at parameters like 'url' and possibly 'host', 'user', etc., but doesn't explain their semantics, relationships (e.g., mutual exclusivity), or defaults. The description provides some context but doesn't fully bridge the coverage gap, warranting a baseline score.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action ('Connect to MySQL database') and the resource ('MySQL database'), making the purpose evident. It specifies the connection method ('using URL or config'), which helps distinguish it from other database operations. However, it doesn't explicitly differentiate from sibling tools like 'execute' or 'query', which might also involve database interactions, so it's not a perfect 5.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention prerequisites (e.g., needing this connection before using other tools like 'query'), exclusions, or contextual cues. With sibling tools like 'execute' and 'query' available, the lack of usage guidelines leaves the agent uncertain about proper sequencing or selection.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.