A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://github.com/KWDB/kwdb-mcp-server below:

GitHub - KWDB/kwdb-mcp-server: KWDB MCP Server

中文版

The KWDB MCP Server is a server implementation based on the MCP (Model Context Protocol) protocol, which provides a set of tools and resources for interacting with the KWDB database and providing business intelligence functionality through the MCP protocol. The KWDB MCP Server supports reading, writing, querying, modifying data, and performing DDL operations.

The core process of the KWDB MCP Server consists of the following components:

The KWDB MCP Server provides the following security measures:

MCP Resources allow the KWDB MCP Server to expose data and content that can be read by MCP clients and used as context for LLM interactions. The KWDB MCP Server provides the following MCP Resources:

Resources URI Format Description Example Product information kwdb://product_info Product information, including the version and supported features kwdb://product_info/ Database metadata kwdb://db_info/{database_name} Information about a specific database, including the engine type, comments, and tables kwdb://db_info/db_shig Table schema kwdb://table/{table_name} Schema of a specific table, including columns and example queries kwdb://table/user_profile

The MCP Tools enable the KWDB MCP Server to expose executable functionality to MCP clients. Through MCP Tools, LLMs can interact with external systems. The KWDB MCP Server provides the following MCP Tools.

The KWDB MCP Server executes the SELECT, SHOW, EXPLAIN statements, and other read-only queries to read data from the database. The read_query function returns the query results in a format of array for your SQL statement. In addition, the KWDB MCP Server will automatically add the LIMIT 20 clause to SELECT queries without a LIMIT clause to prevent large result sets.

Examples:

-- Query table data.
SELECT * FROM users LIMIT 10;

-- List all created tables.
SHOW TABLES;

-- Execute a SQL query and generate details about the SQL query.
EXPLAIN ANALYZE SELECT * FROM orders WHERE user_id = 1;

The KWDB MCP Server executes data modification queries, including DML and DDL operations.

Examples:

-- Insert data into the table.
INSERT INTO users (name, email) VALUES ('John Doe', 'john@example.com');

-- Update data in the table.
UPDATE users SET email = 'new-email@example.com' WHERE id = 1;

-- Remove data from the table.
DELETE FROM users WHERE id = 1;

-- Create a table.
CREATE TABLE products (id SERIAL PRIMARY KEY, name TEXT, price DECIMAL);

-- Add a column to a table.
ALTER TABLE products ADD COLUMN description TEXT;

-- Remove a table.
DROP TABLE products;

MCP Prompts enable the KWDB MCP Server to define reusable prompt templates and workflows that MCP clients can easily surface to users and LLMs. They provide a powerful way to standardize and share common LLM interactions. The KWDB MCP Server provides the following MCP Prompts:

Type Prompt Name Description Database description db_description A comprehensive description of KWDB database, including core functions, supported features, and use cases. Syntax guide syntax_guide A comprehensive syntax guide for KWDB, including examples of common queries and best practices. Cluster management cluster_management A comprehensive guide for managing KWDB clusters, including node management, load balancing, and monitoring. Data migration data_migration A guide for migrating data to and from KWDB, including import/export methods and best practices. Installation installation A step-by-step guide for installing and deploying KWDB in various environments. Performance tunning performance_tuning A guide for optimizing KWDB performance, including query optimization, indexing strategies, and system-level tuning. Troubleshooting troubleshooting A guide for diagnosing and resolving common KWDB issues and errors. Backup and restore backup_restore A comprehensive guide for backing up and restoring KWDB databases, including strategies, tools, and best practices. DBA templates dba_template Templates and guidelines for MCP Prompts writing.

The MCP Prompts are Markdown files stored in the pkg/prompts/docs/ directory. These files are embedded into the binary when compiling the KWDB MCP Server using Go's embed package. Currently, the KWDB MCP Server provides the following Prompts files:

To add MCP Prompts, follow these steps:

  1. Create a Markdown file in the pkg/prompts/docs/ directory, such as new_usecase.md.
  2. Add the variable and load codes in the pkg/prompts/prompts.go file.
  3. Create a registration function for the new MCP Prompts.
  4. Add the registration function call to registerUseCasePrompts() in the pkg/prompts/prompts.go file.
  5. Update the README file.

For details about how to add MCP Prompts, see comments in the pkg/prompts/prompts.go file.

To modify MCP Prompts, follow these steps:

  1. Edit the specific Markdown file(s) in the pkg/prompts/docs/ directory.
  2. Run the make build command to rebuild the application. The updated MCP Prompts will be embedded in the binary.

  1. Clone the repository.

    git clone https://gitee.com/kwdb/kwdb-mcp-server
cd kwdb-mcp-server

  2. Install dependencies.

  3. Build the application.

If you succeed, the application adopts the following structure.

kwdb-mcp-server/
├── bin/
│   └── kwdb-mcp-server      # Binary executable file
├── cmd/
│   └── kwdb-mcp-server/
│       └── main.go           # The main application
├── pkg/
│   ├── db/
│   │   └── db.go             # Database operations
│   ├── prompts/
│   │   ├── prompts.go        # MCP Prompts
│   │   └── docs/             # MCP Prompts files
│   │       ├── ReadExamples.md     # Read query examples
│   │       ├── WriteExamples.md    # Write query examples
│   │       ├── DBDescription.md    # Database descriptions
│   │       ├── SyntaxGuide.md      # SQL Syntax guide
│   │       ├── ClusterManagementGuide.md # Cluster management guide
│   │       ├── DataMigrationGuide.md    # Data migration guide
│   │       ├── InstallationGuide.md      # Installation guide
│   │       ├── PerformanceTuningGuide.md # Performance tunning
│   │       ├── TroubleShootingGuide.md   # Troubleshooting guide
│   │       ├── BackupRestoreGuide.md     # Backup and restore guide
│   │       └── DBATemplate.md            # DBA templates
│   ├── resources/
│   │   └── resources.go      # MCP Resources
│   ├── server/
│   │   └── server.go         # KWDB MCP Server configurations
│   ├── tools/
│   │   └── tools.go          # MCP Tools
│   └── version/
│       └── version.go        # Version information
├── Makefile                  # Commands for building and running the KWDB MCP Server
└── README.md                 # README file

The KWDB MCP Server supports three transport modes:

Parameters:

Parameters:

Note

SSE mode is deprecated and will be removed in future releases. Please use HTTP mode if possible.

Parameters:

Integrate with LLM Agents

For details about how the KWDB MCP Server integerates with LLM Agents, see Integrate with LLM Agents.

For details about how to troubleshoot the KWDB MCP Server, see Troubleshooting.

For documentation about the KWDB MCP Server, see the KWDB Documentation Website.

Contributions are welcome! Please feel free to submit issues and pull requests.

This project is licensed under the MIT License.

kwdb-mcp-server is indexed and certified by MCP Review

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4