pyTigerGraph-mcp 1.0.0__tar.gz

pytigergraph_mcp-1.0.0/LICENSE

@@ -0,0 +1,120 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship made available under
+      the License, as indicated by a copyright notice that is included in
+      or attached to the work (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean, as submitted to the Licensor for inclusion
+      in the Work by the copyright owner or by an individual or Legal Entity
+      authorized to submit on behalf of the copyright owner. For the purposes
+      of this definition, "submitted" means any form of electronic, verbal,
+      or written communication sent to the Licensor or its representatives,
+      including but not limited to communication on electronic mailing lists,
+      source code control systems, and issue tracking systems that are managed
+      by, or on behalf of, the Licensor for the purpose of discussing and
+      improving the Work, but excluding communication that is conspicuously
+      marked or designated in writing by the copyright owner as "Not a
+      Contribution."
+
+      "Contributor" shall mean Licensor and any Legal Entity on behalf of
+      whom a Contribution has been received by the Licensor and included
+      within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of, publicly
+      display, publicly perform, sublicense, and distribute the Work and
+      such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of this
+      License, each Contributor hereby grants to You a perpetual, worldwide,
+      non-exclusive, no-charge, royalty-free, irrevocable patent license to
+      make, have made, use, offer to sell, sell, import, and otherwise
+      transfer the Work.
+
+   4. Redistribution. You may reproduce and distribute copies of the Work
+      or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You meet
+      the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative Works
+          a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works that
+          You distribute, all copyright, patent, trademark, and attribution
+          notices from the Source form of the Work; and
+
+      (d) If the Work includes a "NOTICE" text file, include a readable copy
+          of the attribution notices contained within such NOTICE file.
+
+   5. Submission of Contributions. Any Contribution intentionally submitted
+      for inclusion in the Work shall be under the terms of this License,
+      without any additional terms or conditions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor.
+
+   7. Disclaimer of Warranty. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT
+      WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+      TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE
+      AND NONINFRINGEMENT.
+
+   8. Limitation of Liability. IN NO EVENT SHALL ANY CONTRIBUTOR BE LIABLE
+      FOR ANY DAMAGES.
+
+   9. Accepting Warranty or Additional Liability. While redistributing the
+      Work, You may offer support, warranty, indemnity, or other liability
+      obligations consistent with this License. However, in accepting such
+      obligations, You may offer such conditions only on Your own behalf.
+
+   Copyright 2025 TigerGraph Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0

pytigergraph_mcp-1.0.0/PKG-INFO

@@ -0,0 +1,436 @@
+Metadata-Version: 2.4
+Name: pyTigerGraph-mcp
+Version: 1.0.0
+Summary: Model Context Protocol (MCP) server for TigerGraph
+Author-email: "TigerGraph Inc." <support@tigergraph.com>
+License: Apache-2.0
+Project-URL: Source, https://github.com/tigergraph/tigergraph-mcp
+Project-URL: Bug Reports, https://github.com/tigergraph/tigergraph-mcp/issues
+Project-URL: Documentation, https://docs.tigergraph.com/pytigergraph/current/intro/
+Keywords: TigerGraph,MCP,Model Context Protocol,AI,Graph Database
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Database
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pyTigerGraph>=2.0.1
+Requires-Dist: mcp>=1.0.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: click
+Requires-Dist: python-dotenv>=1.0.0
+Provides-Extra: llm
+Requires-Dist: langchain>=0.3.0; extra == "llm"
+Requires-Dist: langchain-core>=0.3.0; extra == "llm"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.23; extra == "dev"
+Dynamic: license-file
+
+# pyTigerGraph-mcp
+
+Model Context Protocol (MCP) server for TigerGraph — lets AI agents interact with TigerGraph through the MCP standard. All tools use pyTigerGraph's async APIs for optimal performance.
+
+## Table of Contents
+
+- [Requirements](#requirements)
+- [Installation](#installation)
+- [Getting Started](#getting-started)
+- [Usage](#usage)
+  - [Running the MCP Server](#running-the-mcp-server)
+  - [Configuration](#configuration)
+  - [Multiple Connection Profiles](#multiple-connection-profiles)
+  - [Using with Existing Connection](#using-with-existing-connection)
+- [Client Examples](#client-examples)
+  - [Using MultiServerMCPClient](#using-multiserverMCPclient)
+  - [Using MCP Client SDK Directly](#using-mcp-client-sdk-directly)
+- [Available Tools](#available-tools)
+- [LLM-Friendly Features](#llm-friendly-features)
+  - [Structured Responses](#structured-responses)
+  - [Rich Tool Descriptions](#rich-tool-descriptions)
+  - [Token Optimization](#token-optimization)
+  - [Tool Discovery](#tool-discovery)
+- [Notes](#notes)
+
+## Requirements
+
+- **Python 3.10, 3.11, or 3.12**
+- **TigerGraph 4.1 or later** — Install from the [TigerGraph Downloads page](https://dl.tigergraph.com/) or use [TigerGraph Savanna](https://savanna.tgcloud.io/) for a managed cloud instance.
+
+> **Recommended: TigerGraph 4.2+** to enable TigerVector and advanced hybrid retrieval features.
+
+## Installation
+
+```bash
+pip install pyTigerGraph-mcp
+```
+
+This installs:
+- `pyTigerGraph>=2.0.1` — the TigerGraph Python SDK
+- `mcp>=1.0.0` — the MCP SDK
+- `pydantic>=2.0.0` — for data validation
+- `click` — for the CLI entry point
+- `python-dotenv>=1.0.0` — for loading `.env` files
+
+To enable the `tigergraph__generate_gsql` and `tigergraph__generate_cypher` tools (LLM-powered query generation):
+
+```bash
+pip install "pyTigerGraph-mcp[llm]"
+```
+
+> **Migrating from `pyTigerGraph[mcp]`?** `pip install pyTigerGraph[mcp]` now installs `pyTigerGraph-mcp` automatically. Update your imports from `pyTigerGraph.mcp` to `tigergraph_mcp`.
+
+## Getting Started
+
+TigerGraph-MCP supports multiple AI agent frameworks. Choose the one that fits your workflow:
+
+### LangGraph (Recommended)
+
+LangGraph is ideal for building stateful, agent-based workflows with complex tool chaining. Setup guide and full chatbot example:
+
+- [LangGraph Setup](docs/langgraph_setup.md)
+- [Chatbot example code](examples/chatbot_langgraph/)
+- [Example transcripts](docs/chatbot_langgraph_examples/)
+
+### CrewAI
+
+CrewAI provides a simpler starting point for basic agentic workflows with a web-based UI:
+
+- [CrewAI Setup](docs/crewai_setup.md)
+- [Chatbot example code](examples/chatbot_crewai/)
+
+### GitHub Copilot Chat (VS Code)
+
+For quick tasks or straightforward tool invocations directly in your editor:
+
+- [Copilot Chat Setup](docs/copilot_setup.md)
+
+## Usage
+
+### Running the MCP Server
+
+```bash
+tigergraph-mcp
+```
+
+With a custom `.env` file:
+
+```bash
+tigergraph-mcp --env-file /path/to/.env
+```
+
+With verbose logging:
+
+```bash
+tigergraph-mcp -v    # INFO level
+tigergraph-mcp -vv   # DEBUG level
+```
+
+Or programmatically:
+
+```python
+from tigergraph_mcp import serve
+import asyncio
+
+asyncio.run(serve())
+```
+
+### Configuration
+
+The MCP server reads connection configuration from environment variables. You can set these either directly or in a `.env` file.
+
+#### Using a .env File (Recommended)
+
+Create a `.env` file in your project directory:
+
+```bash
+# .env — Username/Password authentication
+TG_HOST=http://localhost
+TG_GRAPHNAME=MyGraph  # Optional — can be omitted if the database has multiple graphs
+TG_USERNAME=tigergraph
+TG_PASSWORD=tigergraph
+TG_RESTPP_PORT=9000
+TG_GS_PORT=14240
+```
+
+Or use an API token instead of username/password:
+
+```bash
+# .env — API Token authentication
+TG_HOST=http://localhost
+TG_GRAPHNAME=MyGraph
+TG_API_TOKEN=your_api_token_here
+```
+
+When `TG_API_TOKEN` (or `TG_JWT_TOKEN`) is set, the server uses token-based authentication (`Authorization: Bearer <token>`) and ignores username/password. You can obtain a token via `pyTigerGraph`'s `getToken()` method or from the TigerGraph Admin Portal.
+
+The server loads the `.env` file automatically. Environment variables take precedence over `.env` values.
+
+#### Environment Variables
+
+| Variable | Default | Description |
+|---|---|---|
+| `TG_HOST` | `http://127.0.0.1` | TigerGraph host |
+| `TG_GRAPHNAME` | _(empty)_ | Graph name (optional) |
+| `TG_USERNAME` | `tigergraph` | Username |
+| `TG_PASSWORD` | `tigergraph` | Password |
+| `TG_SECRET` | _(empty)_ | GSQL secret (optional) |
+| `TG_API_TOKEN` | _(empty)_ | API token (optional) |
+| `TG_JWT_TOKEN` | _(empty)_ | JWT token (optional) |
+| `TG_RESTPP_PORT` | `9000` | REST++ port |
+| `TG_GS_PORT` | `14240` | GSQL port |
+| `TG_SSL_PORT` | `443` | SSL port |
+| `TG_TGCLOUD` | `false` | Whether using TigerGraph Cloud |
+| `TG_CERT_PATH` | _(empty)_ | Path to certificate (optional) |
+
+### Multiple Connection Profiles
+
+Define named profiles in your `.env` to work with multiple TigerGraph environments without changing any code.
+
+#### Defining profiles
+
+Each named profile uses a `<PROFILE>_` prefix on the standard `TG_*` variables. Only variables that differ from the default need to be set.
+
+```bash
+# .env
+
+# Default profile (no prefix) — password auth
+TG_HOST=http://localhost
+TG_USERNAME=tigergraph
+TG_PASSWORD=tigergraph
+TG_GRAPHNAME=MyGraph
+
+# Staging profile — token auth
+STAGING_TG_HOST=https://staging.example.com
+STAGING_TG_API_TOKEN=staging_token_here
+STAGING_TG_TGCLOUD=true
+
+# Production profile — password auth
+PROD_TG_HOST=https://prod.example.com
+PROD_TG_USERNAME=admin
+PROD_TG_PASSWORD=prod_secret
+PROD_TG_GRAPHNAME=ProdGraph
+PROD_TG_TGCLOUD=true
+```
+
+Profiles are discovered automatically at startup. Any variable matching `<PROFILE>_TG_HOST` registers a new profile. Values not set for a named profile fall back to the default profile's values.
+
+#### Selecting the active profile
+
+```bash
+# Switch to staging for this run
+TG_PROFILE=staging tigergraph-mcp
+
+# Or set permanently in .env
+TG_PROFILE=prod
+```
+
+If `TG_PROFILE` is not set, the default profile is used.
+
+### Using with Existing Connection
+
+```python
+from pyTigerGraph import AsyncTigerGraphConnection
+from tigergraph_mcp import ConnectionManager
+
+async with AsyncTigerGraphConnection(
+    host="http://localhost",
+    graphname="MyGraph",
+    username="tigergraph",
+    password="tigergraph",
+) as conn:
+    ConnectionManager.set_default_connection(conn)
+    # ... run MCP tools ...
+# HTTP connection pool is released on exit
+```
+
+## Client Examples
+
+### Using MultiServerMCPClient
+
+```python
+from langchain_mcp_adapters import MultiServerMCPClient
+from pathlib import Path
+from dotenv import dotenv_values
+import asyncio
+
+env_dict = dotenv_values(dotenv_path=Path(".env").expanduser().resolve())
+
+client = MultiServerMCPClient(
+    {
+        "tigergraph-mcp-server": {
+            "transport": "stdio",
+            "command": "tigergraph-mcp",
+            "args": ["-vv"],
+            "env": env_dict,
+        },
+    }
+)
+
+tools = asyncio.run(client.get_tools())
+```
+
+### Using MCP Client SDK Directly
+
+```python
+import asyncio
+from mcp import ClientSession, StdioServerParameters
+from mcp.client.stdio import stdio_client
+
+async def call_tool():
+    server_params = StdioServerParameters(
+        command="tigergraph-mcp",
+        args=["-vv"],
+    )
+
+    async with stdio_client(server_params) as (read, write):
+        async with ClientSession(read, write) as session:
+            await session.initialize()
+
+            tools = await session.list_tools()
+            print(f"Available tools: {[t.name for t in tools.tools]}")
+
+            result = await session.call_tool(
+                "tigergraph__list_graphs",
+                arguments={}
+            )
+            for content in result.content:
+                print(content.text)
+
+asyncio.run(call_tool())
+```
+
+## Available Tools
+
+### Global Schema Operations
+- `tigergraph__get_global_schema` — Get the complete global schema via GSQL `LS`
+
+### Graph Operations
+- `tigergraph__list_graphs` — List all graph names in the database
+- `tigergraph__create_graph` — Create a new graph with schema
+- `tigergraph__drop_graph` — Drop a graph and its schema
+- `tigergraph__clear_graph_data` — Clear all data from a graph (keeps schema)
+
+### Schema Operations
+- `tigergraph__get_graph_schema` — Get schema as structured JSON
+- `tigergraph__show_graph_details` — Show schema, queries, loading jobs, and data sources
+
+### Node Operations
+- `tigergraph__add_node` / `tigergraph__add_nodes`
+- `tigergraph__get_node` / `tigergraph__get_nodes`
+- `tigergraph__delete_node` / `tigergraph__delete_nodes`
+- `tigergraph__has_node`
+- `tigergraph__get_node_edges`
+
+### Edge Operations
+- `tigergraph__add_edge` / `tigergraph__add_edges`
+- `tigergraph__get_edge` / `tigergraph__get_edges`
+- `tigergraph__delete_edge` / `tigergraph__delete_edges`
+- `tigergraph__has_edge`
+
+### Query Operations
+- `tigergraph__run_query` — Run an interpreted query
+- `tigergraph__run_installed_query` — Run an installed query
+- `tigergraph__install_query` / `tigergraph__drop_query`
+- `tigergraph__show_query` / `tigergraph__get_query_metadata` / `tigergraph__is_query_installed`
+- `tigergraph__get_neighbors`
+
+### Loading Job Operations
+- `tigergraph__create_loading_job`
+- `tigergraph__run_loading_job_with_file` / `tigergraph__run_loading_job_with_data`
+- `tigergraph__get_loading_jobs` / `tigergraph__get_loading_job_status`
+- `tigergraph__drop_loading_job`
+
+### Statistics Operations
+- `tigergraph__get_vertex_count` / `tigergraph__get_edge_count`
+- `tigergraph__get_node_degree`
+
+### GSQL Operations
+- `tigergraph__gsql` — Execute raw GSQL
+- `tigergraph__generate_gsql` — Generate GSQL from natural language (requires `[llm]`)
+- `tigergraph__generate_cypher` — Generate openCypher from natural language (requires `[llm]`)
+
+### Vector Schema Operations
+- `tigergraph__add_vector_attribute` / `tigergraph__drop_vector_attribute`
+- `tigergraph__list_vector_attributes` / `tigergraph__get_vector_index_status`
+
+### Vector Data Operations
+- `tigergraph__upsert_vectors`
+- `tigergraph__load_vectors_from_csv` / `tigergraph__load_vectors_from_json`
+- `tigergraph__search_top_k_similarity` / `tigergraph__fetch_vector`
+
+### Data Source Operations
+- `tigergraph__create_data_source` / `tigergraph__update_data_source`
+- `tigergraph__get_data_source` / `tigergraph__drop_data_source`
+- `tigergraph__get_all_data_sources` / `tigergraph__drop_all_data_sources`
+- `tigergraph__preview_sample_data`
+
+### Discovery & Navigation
+- `tigergraph__discover_tools` — Search for tools by description or keywords
+- `tigergraph__get_workflow` — Get step-by-step workflow templates
+- `tigergraph__get_tool_info` — Get detailed information about a specific tool
+
+## LLM-Friendly Features
+
+### Structured Responses
+
+Every tool returns a consistent JSON structure:
+
+```json
+{
+  "success": true,
+  "operation": "get_node",
+  "summary": "Found vertex 'p123' of type 'Person'",
+  "data": { ... },
+  "suggestions": ["View connected edges: get_node_edges(...)"],
+  "metadata": { "graph_name": "MyGraph" }
+}
+```
+
+Error responses include actionable recovery hints:
+
+```json
+{
+  "success": false,
+  "operation": "get_node",
+  "error": "Vertex not found",
+  "suggestions": ["Verify the vertex_id is correct"]
+}
+```
+
+### Rich Tool Descriptions
+
+Each tool includes detailed descriptions with use cases, common workflows, tips, warnings, and related tools.
+
+### Token Optimization
+
+Responses are designed for efficient LLM token usage — no echoing of input parameters, only new information (results, counts, boolean answers).
+
+### Tool Discovery
+
+```python
+# Find the right tool
+result = await session.call_tool("tigergraph__discover_tools",
+    arguments={"query": "how to add data to the graph"})
+
+# Get a workflow template
+result = await session.call_tool("tigergraph__get_workflow",
+    arguments={"workflow_type": "data_loading"})
+
+# Get detailed tool info
+result = await session.call_tool("tigergraph__get_tool_info",
+    arguments={"tool_name": "tigergraph__add_node"})
+```
+
+## Notes
+
+- **Transport**: stdio by default
+- **Error Detection**: GSQL operations include error detection for syntax and semantic errors
+- **Connection Management**: Connections are pooled by profile and reused across requests; pool is released at server shutdown
+- **Performance**: Persistent HTTP connection pool per profile; async non-blocking I/O; `v.outdegree()` for O(1) degree counting; batch operations for multiple vertices/edges