TigerGraph-MCP Documentation

Table of Contents

1. Requirements
2. Features
3. Admin Features
4. Project Structure
5. Installation
6. Configuration
7. Running Chat Bot
8. Connecting to Claude Desktop
9. Contributing
10. License
11. Releases

Requirements

• You will need to run TigerGraph Version >= 4.2.0.
• Setup local environment with Python >= 3.12.

Features

• Schema Introspection: Retrieve full graph schema.
• Query View: Retrieve list of available queries.
• Query Execution: Run installed GSQL queries.
• Creation Vertex & Edge: Create Vertices and Edges programmatically.
• Alter Vertex: Allows for altering the Vertex.
• Upsert Vertex & Edge: Update vertices and edges attributes programmatically.
• UDF & Algorithm Listing: Fetch installed user-defined functions.

Admin Features

• displayService_Status: Displays the database service status.
• displayDetailed_Service_Status: Provides detailed service status.
• displayComponent_Version: Displays all component versions.
• displayCPUMemory_Usage: Displays CPU and Memory Usage.
• displayDiskSpace_Usage: Displays Disk Usage.

Installation

1. Clone the repo: git clone https://github.com/customdiscoveries/TigerGraph_MCP.git
2. Copy Example Configuration files.
3. Create, Install Dependencies & Activate a virtual environment.

Configuration Setup

• Edit your .env configuration file with required attributes.

Running Chat Bot

• Invoke the script runChatBot.sh to run the Chat Bot.

Connecting to Claude Desktop

• Install into the Claude Desktop client.

Contributing

1. Fork the repository.
2. Create a feature branch.
3. Commit your changes.
4. Push to branch.
5. Open a Pull Request.

License

This project is licensed under the MIT License.

Releases

V3.0 is the latest release.