DBtoolReader

DBtoolReader is a PostgreSQL database tool that provides a server interface for executing database queries and retrieving schema information. It's built using Go and integrates with the MCP (Model-Controller-Protocol) server framework which make it usable with any LLM and LLM System.

Features

- Execute PostgreSQL database queries
- Retrieve database schema information
- Stdio-based server interface
- Built on the MCP-Go framework

Prerequisites

- Go 1.16 or higher
- PostgreSQL database
- Access credentials for your PostgreSQL database

Installation

1. Clone the repository:

git clone [repository-url]

cd DBtoolReader

2. Install dependencies:

go mod download

3. Build the project:

go build -o dbtoolreader

Usage

The tool provides two main functionalities:

1. Database Query Tool: Execute queries against your PostgreSQL database
2. Schema Tool: Retrieve schema information from your PostgreSQL database

The server communicates through standard input/output, making it suitable for integration with other tools and services.

Running the Server

./dbtoolreader

The server will start and listen for commands through stdin/stdout.

Project Structure

- main.go - Entry point of the application
- tools/ - Directory containing the core functionality
- dbQueryTool.go - Implementation of the database query functionality
- getSchemaTool.go - Implementation of the schema retrieval functionality

Dependencies

- github.com/mark3labs/mcp-go - MCP server framework
- Other dependencies as listed in go.mod

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

[Add your license information here]

Support

For support, please [add contact information or issue tracker details]