What is Tsurugi Mcp Server

tsurugi-mcp-server is a Model Context Protocol server designed to access Tsurugi, a database management system. It enables users to interact with Tsurugi’s data through various SQL operations and metadata retrieval.

Use cases

Use cases include data retrieval and manipulation for applications, generating reports from database queries, and integrating Tsurugi with other software systems for enhanced data handling.

How to use

To use tsurugi-mcp-server, download the JAR file from the release page. Configure it in the ‘mcpServers’ section of your ‘claude_desktop_config.json’ file, specifying the command to run the server and its arguments.

Key features

Key features include tools for listing table names, retrieving table metadata, executing SQL queries, and performing DDL operations. It supports multiple transaction types and allows continuation of queries with cursors.

Where to use

tsurugi-mcp-server is suitable for use in database management, data analysis, and applications requiring SQL database interactions, particularly in environments utilizing the Tsurugi database.

tsurugi-mcp-server

Model Context Protocol server to access Tsurugi.

Limitations

• Tsurugi 1.4.0 or later.
• Java21 or later.

Components

Tools

• listTableNames
  • list table names.
• getTableMetadata
  • get table metadata (table schema).
  • parameter
    • tableName - table name (string, required)
• query
  • execute SQL (select).
  • parameter
    • sql - SQL (string, required)
    • transaction_type - OCC, LTX, RTX. (string, default: RTX)
    • cursor - To continue the previous query. (string)
  • If there is a continuation, nextCursor is returned.
• update
  • execute SQL (insert, update, delete).
  • parameter
    • sql - SQL (string, required)
    • transaction_type - OCC, LTX. (string, default: OCC)
    • write_preserve - write preserve table names. (string, required when transaction_type is LTX)
• executeDdl
  • execute DDL (create, drop)
  • parameter
    • sql - SQL (string, required)
    • transaction_type - OCC, LTX. (string, default: OCC)

Resources

• table metadata

Prompts

• tableList-prompt
  • Prompt to display the list of tables.
• tableMetadata-prompt
  • Prompt to display the table metadata.
• query-prompt
  • Prompt to display the table data.

Configuration

Usage with Claude Desktop

First, download the tsurugi-mcp-server jar file from release page.

To use this server with the Claude Desktop, add the following configuration to the “mcpServers” section of your claude_desktop_config.json:

{
  "mcpServers": {
    "tsurugidb": {
      "command": "java",
      "args": [
        "-jar",
        "/path/to/tsurugi-mcp-server-all.jar",
        "-c",
        "tcp://localhost:12345"
      ]
    }
  }
}

• command
  • If the java command is not included in the PATH, specify the full path. (e.g., "C:/Program Files/Java/jdk-21/bin/java")
• args
  • Specify the jar file by full path.
  • -c or --connection - the endpoint URL to connect Tsurugi. (required)
  • If you want to limit the tools used, add --enable-tools. (e.g., for read-only access: "--enable-tools", "listTableNames, getTableMetadata, query")
  • If resources is not used, add "--resource", "false".
  • If prompts is not used, add "--prompt", "false".

How to build

cd tsurugi-mcp-server
./gradlew shadowJar
ls build/libs/

How to test

cd tsurugi-mcp-server
./gradlew test -Pdbtest.endpoint=tcp://localhost:12345

License

Apache License, Version 2.0