README Cleanup (#30)

This commit is contained in:
Mahesh Murag
2024-11-24 04:27:08 +01:00
committed by GitHub
parent ec3c60c0c0
commit a1120c307b
14 changed files with 252 additions and 52 deletions

View File

@@ -23,18 +23,46 @@ The server provides a demonstration prompt:
The server offers six core tools:
#### Query Tools
- `read-query`: Execute SELECT queries on the database
- `write-query`: Execute INSERT, UPDATE, or DELETE queries
- `create-table`: Create new database tables
- `read-query`
- Execute SELECT queries to read data from the database
- Input:
- `query` (string): The SELECT SQL query to execute
- Returns: Query results as array of objects
- `write-query`
- Execute INSERT, UPDATE, or DELETE queries
- Input:
- `query` (string): The SQL modification query
- Returns: `{ affected_rows: number }`
- `create-table`
- Create new tables in the database
- Input:
- `query` (string): CREATE TABLE SQL statement
- Returns: Confirmation of table creation
#### Schema Tools
- `list-tables`: Get a list of all tables in the database
- `describe-table`: View the schema of a specific table
- `list-tables`
- Get a list of all tables in the database
- No input required
- Returns: Array of table names
- `describe-table`
- View schema information for a specific table
- Input:
- `table_name` (string): Name of table to describe
- Returns: Array of column definitions with names and types
#### Analysis Tools
- `append-insight`: Add new business insights to the memo resource
- `append-insight`
- Add new business insights to the memo resource
- Input:
- `insight` (string): Business insight discovered from data analysis
- Returns: Confirmation of insight addition
- Triggers update of memo://insights resource
## Installation
## Usage with Claude Desktop
```bash
# Add the server to your claude_desktop_config.json
@@ -52,3 +80,7 @@ The server offers six core tools:
}
}
```
## License
This MCP server is licensed under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms and conditions of the MIT License. For more details, please see the LICENSE file in the project repository.