Skip to content

Commit 4c0d85e

Browse files
committed
Tweak README for clarity and conciseness after review
1 parent 790c675 commit 4c0d85e

File tree

1 file changed

+0
-10
lines changed

1 file changed

+0
-10
lines changed

README.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -121,20 +121,10 @@ The main tool, `visualize_graph`, now accepts a single `graph_data` dictionary.
121121

122122
### What We Learned / Caveats & Gotchas
123123

124-
- **API Version:** You must call `graphistry.register()` with `api=3` and your credentials before using any Graphistry features. Otherwise, the client defaults to API v1, which requires an API key and will fail.
125124
- **Environment Variables:** Always ensure `GRAPHISTRY_USERNAME` and `GRAPHISTRY_PASSWORD` are set in the environment where the server runs. Debug prints can help verify this.
126125
- **Virtual Environment:** Use the venv's Python directly or activate the environment before running the server. This avoids dependency and path issues.
127126
- **LLM Tool Schemas:** LLMs and tool bridges work best with single-argument (dict) APIs. Avoid multi-argument signatures for tools you want to expose to LLMs.
128-
- **Debugging:** Add verbose debug prints for environment and registration issues. This saves hours of confusion!
129127
- **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.
130-
- **State Files:** If you see references to scripts or files that don't exist (like `verify-installation.sh`), ignore or remove them—they may be from earlier versions.
131-
132-
## Troubleshooting
133-
134-
- **API key errors:** Means you are using API v1. Fix by calling `graphistry.register(api=3, ...)` with your credentials.
135-
- **Credentials not found:** Double-check your environment variables and .env file.
136-
- **Module not found:** Make sure you installed the package in editable mode (`pip install -e .`) and are using the correct Python environment.
137-
- **Server not responding:** Check logs and debug prints for environment or registration issues.
138128

139129
## Contributing
140130

0 commit comments

Comments
 (0)