Openlinksoftware MCP Odbc Server

🚀 mcp-odbc-server

This guide details how to install and configure the mcp-odbc-server and demonstrates its usage in various tools, including Claude Desktop, Cline Visual Studio Extension, and Cursor Editor. Through these steps, users can easily interact with ODBC data sources and execute various queries.

🚀 Quick Start

This guide provides a comprehensive overview of installing, configuring, and using the mcp-odbc-server. It also includes troubleshooting tips and reference materials to help you get started with ODBC data interaction.

✨ Features

• Install and configure the mcp-odbc-server.
• Use the server in different tools like Claude Desktop, Cline Visual Studio Extension, and Cursor Editor.
• Interact with ODBC data sources and execute queries.

📦 Installation

System Requirements

• Node.js version: v21.1.0 or higher
• npm (Node Package Manager)

Installation Guide

1. Clone the repository:

   git clone https://github.com/your-repository/mcp-odbc-server.git
   cd mcp-odbc-server
   

2. Install dependencies:

   npm install
   

3. Start the server:

   tsx src/main.ts
   

📚 Documentation

Configuration Guide

Environment Variable Configuration

Edit the src/server.ts file and add the following environment variables:

import { environment } from './environment';

export const config = {
  ODBC_DSN: process.env.ODBC_DSN || 'YourDSN',
  NODE_VERSION: process.env.NODE_VERSION,
  PATH: process.env.PATH,
};

Start Script

Create a start script in package.json:

{
  "scripts": {
    "start": "set NODE_VERSION=v21.1.0 && set PATH=~/.nvm/versions/node/v21.1.0/bin:${PATH} && tsx src/main.ts"
  }
}

Tool Configuration

Claude Desktop Configuration

Edit the ~/.config/claude/settings.json file and add the following content:

{
  "mcpServers": {
    "ODBC": {
      "command": "/path/to/node",
      "args": ["tsx", "src/main.ts"],
      "env": {
        "ODBC_DSN": "YourDSN"
      }
    }
  }
}

Cline Visual Studio Extension Configuration

Edit the ~/.config/vscode/settings.json file and add the following content:

{
  "extensions.claude-dev.settings.mcpServers.ODBC": {
    "command": "/path/to/node",
    "args": ["tsx", "src/main.ts"],
    "env": {
      "ODBC_DSN": "YourDSN"
    }
  }
}

Cursor Editor Configuration

Edit the ~/.config/cursor/settings.json file and add the following content:

{
  "mcpServers": {
    "ODBC": {
      "command": "/path/to/node",
      "args": ["tsx", "src/main.ts"],
      "env": {
        "ODBC_DSN": "YourDSN"
      }
    }
  }
}

Usage Guide

Using in Claude Desktop

1. Launch Claude Desktop.
2. Open the terminal and run the following command:

   npm start
   

Using in Cline Visual Studio Extension

1. Open Visual Studio Code.
2. Install the Cline plugin.
3. After configuration, run the following command in the terminal:

   npm start
   

Using in Cursor Editor

1. Launch Cursor Editor.
2. Open the terminal and run the following command:

   npm start
   

💻 Usage Examples

Basic Usage

import { query } from './db';

export async function getData() {
  const result = await query('SELECT * FROM YourTable');
  return result;
}

Advanced Usage

import { execute } from './db';

export async function insertData(data: any) {
  const query = 'INSERT INTO YourTable VALUES (?)';
  await execute(query, [data]);
}

🔧 Troubleshooting

• Problem: Server fails to start.

• Solution: Check if the Node.js version and environment variables are correctly configured.

• Problem: Unable to connect to the data source.

• Solution: Verify that the ODBC DSN name and driver are correctly installed.

📄 Reference Materials

• Node.js Official Documentation
• TypeScript Official Documentation
• MCP Project Documentation

By following the above steps, you can easily configure and use the mcp-odbc-server for efficient ODBC data interaction in various tools.