Model Context Protocol - Nile Documentation

The Model Context Protocol (MCP) is a standardized interface that enables Large Language Models (LLMs) like Claude to interact with external tools and services. For Nile, MCP provides a natural language interface to manage databases, execute queries, and handle database operations through AI assistants. Key benefits:

Natural language interaction with your databases
Standardized interface across different AI tools
Type-safe operations with input validation
Real-time database management and querying
Secure credential handling

Installing Nile Model Context Protocol

Stable Version

npm install @niledatabase/nile-mcp-server

This will install @niledatabase/nile-mcp-server in your node_modules folder. For example: node_modules/@niledatabase/nile-mcp-server/dist/

Latest Alpha/Preview Version

npm install @niledatabase/nile-mcp-server@alpha

This will install @niledatabase/nile-mcp-server in your node_modules folder. For example: node_modules/@niledatabase/nile-mcp-server/dist/

Manual Installation

# Clone the repository
git clone https://github.com/yourusername/nile-mcp-server.git
cd nile-mcp-server

# Install dependencies
npm install

# Build the project
npm run build

Configuration

Create a .env file in your project root:

NILE_API_KEY=your_api_key_here
NILE_WORKSPACE_SLUG=your_workspace_slug

You can get the API key and workspace from Nile console. Note the workspace name at the top and you can create an API key from the Security tab on the left. API Key Workspace

Available Tools

Database Management

create-database: Create new databases
list-databases: List all databases in workspace
get-database: Get detailed database information
delete-database: Delete databases

Credential Management

list-credentials: List database credentials
create-credential: Create new database credentials

Region Management

list-regions: List available regions for database creation

SQL Operations

execute-sql: Execute SQL queries with results as markdown tables

Resource Management

read-resource: Get detailed schema information
list-resources: List all database resources

Tenant Management

list-tenants: List all database tenants
create-tenant: Create new tenants
delete-tenant: Delete existing tenants

Server Modes

STDIN Mode (Default)

STDIN mode uses standard input/output for communication, ideal for direct integration with AI tools.

Start the server:

node dist/index.js

The server automatically uses STDIN/STDOUT for communication

SSE Mode

Server-Sent Events (SSE) mode enables HTTP-based, event-driven communication.

Configure SSE mode in .env:

MCP_SERVER_MODE=sse

Start the server:

node dist/index.js

Connect to SSE endpoint:

# Listen for events
curl -N http://localhost:3000/sse

Send commands:

# Send a command
curl -X POST http://localhost:3000/messages \
  -H "Content-Type: application/json" \
  -d '{
    "type": "function",
    "name": "list-databases",
    "parameters": {}
  }'

Claude Desktop Setup

Install Claude Desktop
Configure MCP Server:
- Open Claude Desktop
- Go to Settings > MCP Servers
- Click “Add Server”
- Add configuration:

{
  "mcpServers": {
    "nile-database": {
      "command": "node",
      "args": [
        "/path/to/your/nile-mcp-server/dist/index.js"
      ],
      "env": {
        "NILE_API_KEY": "your_api_key_here",
        "NILE_WORKSPACE_SLUG": "your_workspace_slug"
      }
    }
  }
}

Replace:
- /path/to/your/nile-mcp-server with your actual project path
- your_api_key_here with your Nile API key
- your_workspace_slug with your workspace slug
Click Save and restart Claude Desktop

Cursor Setup

Install Cursor
Configure MCP Server:
- Open Cursor
- Go to Settings (⌘,) > Features > MCP Servers
- Click “Add New MCP Server”

Add server configuration:

Name: nile-database

Command:

env NILE_API_KEY=your_key NILE_WORKSPACE_SLUG=your_workspace node /absolute/path/to/nile-mcp-server/dist/index.js

Replace:
- your_key with your Nile API key
- your_workspace with your workspace slug
- /absolute/path/to with your project path
Click Save and restart Cursor

Windsurf Setup

Open Windsurf and go to the Cascade assistant
Click on the hammmer icon (should show MCP on hover) and then on configure
Paste the configuration below into the mcp_configuration.json file

{
 "mcpServers": {
   "nile-database": {
     "command": "node",
     "args": [
       "/path/to/your/nile-mcp-server/dist/index.js"
     ],
     "env": {
       "NILE_API_KEY": "your_api_key_here",
       "NILE_WORKSPACE_SLUG": "your_workspace_slug"
     }
   }
 }
}

Replace:
- /path/to/your/nile-mcp-server with your actual project path
- your_api_key_here with your Nile API key
- your_workspace_slug with your workspace slug
On saving, Windsurf will ask for confirmation. Once confirmed, it should show nile-database MCP active with a green active status

Cline Setup

Click on MCP Servers in the Cline chat window
Click on the Installed tab and tap the “Configure MCP Servers” SignOutButton
Paste the configuration below into the cline_mcp_settings.json file

{
  "mcpServers": {
    "nile-database": {
      "command": "node",
      "args": [
        "/path/to/your/nile-mcp-server/dist/index.js"
      ],
      "env": {
        "NILE_API_KEY": "your_api_key_here",
        "NILE_WORKSPACE_SLUG": "your_workspace_slug"
      }
    }
  }
}

Replace:
- /path/to/your/nile-mcp-server with your actual project path
- your_api_key_here with your Nile API key
- your_workspace_slug with your workspace slug
On saving, Cline will ask for confirmation. Once confirmed, it should show nile-database MCP active with a green active status

Claude Code Setup

Install Claude Code

npm install -g @anthropic-ai/claude-code

Add the MCP Server to Claude Code (note that right now Claude Code only supports STDIO mode, not SSE):

claude mcp add nile_local_mcp node /path/to/your/nile-mcp-server/dist/index.js -e NILE_API_KEY=your_api_key_here -e NILE_WORKSPACE_SLUG=your_workspace_slug

You should see the following output:

Added stdio MCP server nile_local_mcp with command: node /path/to/your/nile-mcp-server/dist/index.js to project config

You can now use the MCP Server in Claude Code:

Example Usage

# Create a database
"Create a new database named 'my-app' in AWS_US_WEST_2"

# List databases
"Show me all my databases"

# Execute SQL
"Run this query on my-app: SELECT * FROM users LIMIT 5"

# Get schema information
"Show me the schema for the users table in my-app"

Troubleshooting

Common Issues

Connection Issues
- Verify API key and workspace slug
- Check server path in configuration
- Ensure project is built (npm run build)
Permission Issues
- Verify API key permissions
- Check workspace access
- Ensure correct environment variables
Tool Access Issues
- Restart AI tool (Claude/Cursor)
- Check server logs for errors
- Verify tool configuration

Getting Help

Check server logs in the logs directory
Review error messages in AI tool
Ensure all environment variables are set
Verify network connectivity

Artificial Intelligence

​Installing Nile Model Context Protocol

​Stable Version

​Latest Alpha/Preview Version

​Manual Installation

​Configuration

​Available Tools

​Database Management

​Credential Management

​Region Management

​SQL Operations

​Resource Management

​Tenant Management

​Server Modes

​STDIN Mode (Default)

​SSE Mode

​Claude Desktop Setup

​Cursor Setup

​Windsurf Setup

​Cline Setup

​Claude Code Setup

​Example Usage

​Troubleshooting

​Common Issues

​Getting Help