|
| 1 | +# TigerGraph |
| 2 | + |
| 3 | +Connect Claude to any TigerGraph deployment — self-managed, on-premise, or a TigerGraph |
| 4 | +Savanna instance — using your own host and credentials. Claude can explore and evolve the |
| 5 | +graph schema, read and write vertices and edges, run GSQL and Cypher queries, install and |
| 6 | +run stored queries, load data from files and data sources, and search vector embeddings. |
| 7 | + |
| 8 | +The plugin runs the open-source [tigergraph-mcp](https://github.com/tigergraph/tigergraph-mcp) |
| 9 | +server on your machine. It works in Claude Code. |
| 10 | + |
| 11 | +## Requirements |
| 12 | + |
| 13 | +- [uv](https://docs.astral.sh/uv/) on your `PATH`. The plugin starts the server with `uvx`, |
| 14 | + which also provides a suitable Python if one isn't installed. |
| 15 | +- A TigerGraph instance you can reach from your machine, and an account on it. |
| 16 | + |
| 17 | +## Install |
| 18 | + |
| 19 | +```bash |
| 20 | +claude plugin marketplace add tigergraph/tigergraph-mcp |
| 21 | +claude plugin install tigergraph@tigergraph |
| 22 | +``` |
| 23 | + |
| 24 | +## Configuration |
| 25 | + |
| 26 | +At install time, Claude Code asks for: |
| 27 | + |
| 28 | +| Option | Required | Description | |
| 29 | +|---|---|---| |
| 30 | +| TigerGraph host | Yes | Host URL of the instance, for example `https://mycompany.i.tgcloud.io` | |
| 31 | +| Username | No | Account to connect as. Defaults to `tigergraph` | |
| 32 | +| Password | No | Password for that account | |
| 33 | +| Default graph | No | Graph to use when a request doesn't name one | |
| 34 | +| API token | No | Used instead of the password when set | |
| 35 | +| Tools to offer | No | Limits which tools Claude can use, such as `read-only`. Empty offers all of them | |
| 36 | + |
| 37 | +The password and API token are kept in secure storage, not in a settings file. To change |
| 38 | +any option later, open `/plugin`, select **TigerGraph (Self-Managed MCP)** on the |
| 39 | +**Installed** tab, and choose **Configure options**. |
| 40 | + |
| 41 | +## What the plugin runs and sends |
| 42 | + |
| 43 | +- **Download:** when it starts, `uvx` downloads the pinned `tigergraph-mcp` package and its |
| 44 | + dependencies from PyPI, then caches them. |
| 45 | +- **Network:** the server connects only to the TigerGraph host you configure. It sends that |
| 46 | + host your credentials and the requests Claude makes. |
| 47 | +- **Local files:** the tools that load data or vectors from a file read the file path Claude |
| 48 | + gives them and send its contents to your TigerGraph host. |
| 49 | +- **Environment:** the server also reads a `.env` file from the working directory or a parent |
| 50 | + directory, if one exists. Options entered at install take precedence over it. |
| 51 | +- **No telemetry:** the plugin doesn't collect usage data or send anything to TigerGraph or |
| 52 | + other third parties. The query-generation tools, which call an LLM provider, aren't |
| 53 | + available in the plugin. |
| 54 | + |
| 55 | +## Permissions |
| 56 | + |
| 57 | +In permission rules, a skill's `allowed-tools`, or a hook matcher, the plugin's server is |
| 58 | +named `plugin:tigergraph:tigergraph`. |
| 59 | + |
| 60 | +## Documentation and support |
| 61 | + |
| 62 | +- Full documentation: <https://github.com/tigergraph/tigergraph-mcp#readme> |
| 63 | +- Issues: <https://github.com/tigergraph/tigergraph-mcp/issues> |
| 64 | + |
| 65 | +## License |
| 66 | + |
| 67 | +Apache-2.0 |
0 commit comments