Skip to content

Commit 3a08d38

Browse files
committed
Update README: remove caveats section, add concise list of all available MCP tools for user clarity
1 parent 6602180 commit 3a08d38

File tree

1 file changed

+20
-5
lines changed

1 file changed

+20
-5
lines changed

README.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -159,11 +159,26 @@ Example (hypergraph):
159159
}
160160
```
161161

162-
### What We Learned / Caveats & Gotchas
163-
164-
- **Environment Variables & .env:** Always ensure `GRAPHISTRY_USERNAME` and `GRAPHISTRY_PASSWORD` are set in the environment or `.env` file. The server loads `.env` automatically using `python-dotenv`.
165-
- **Virtual Environment:** Use the venv's Python directly or activate the environment before running the server. This avoids dependency and path issues.
166-
- **Cursor Integration:** When adding to Cursor, use the full path to the venv's Python and ensure all environment variables are set in the config.
162+
## Available MCP Tools
163+
164+
The following MCP tools are available for graph visualization, analysis, and manipulation:
165+
166+
- **visualize_graph**: Visualize a graph or hypergraph using Graphistry's GPU-accelerated renderer.
167+
- **get_graph_ids**: List all stored graph IDs in the current session.
168+
- **get_graph_info**: Get metadata (node/edge counts, title, description) for a stored graph.
169+
- **apply_layout**: Apply a standard layout (force_directed, radial, circle, grid) to a graph.
170+
- **detect_patterns**: Run network analysis (centrality, community detection, path finding, anomaly detection).
171+
- **encode_point_color**: Set node color encoding by column (categorical or continuous).
172+
- **encode_point_size**: Set node size encoding by column (categorical or continuous).
173+
- **encode_point_icon**: Set node icon encoding by column (categorical, with icon mapping or binning).
174+
- **encode_point_badge**: Set node badge encoding by column (categorical, with icon mapping or binning).
175+
- **apply_ring_categorical_layout**: Arrange nodes in rings by a categorical column (e.g., group/type).
176+
- **apply_group_in_a_box_layout**: Arrange nodes in group-in-a-box layout (requires igraph).
177+
- **apply_modularity_weighted_layout**: Arrange nodes by modularity-weighted layout (requires igraph).
178+
- **apply_ring_continuous_layout**: Arrange nodes in rings by a continuous column (e.g., score).
179+
- **apply_time_ring_layout**: Arrange nodes in rings by a datetime column (e.g., created_at).
180+
- **apply_tree_layout**: Arrange nodes in a tree (layered hierarchical) layout.
181+
- **set_graph_settings**: Set advanced visualization settings (point size, edge influence, etc.).
167182

168183
## Contributing
169184

0 commit comments

Comments
 (0)