CypherWolf MCP server — Neo4j Cypher query revision from a curated corpus, for @neo4j.com users.
Project description
cypherwolf-mcp
CypherWolf revises Neo4j Cypher queries against a curated corpus of Neo4j engineering precedent, returning compatibility-gated precedent options plus the index/constraint validation gates to confirm before applying changes.
It ships as a single-tool MCP server (revise_query) that runs locally over
stdio and proxies to the CypherWolf HTTPS service. Access is restricted to
@neo4j.com users. The package holds no API key, no shared secret,
and no Aura credentials — all access control is enforced server-side via an
email gate plus a 30-day session token.
Install
CypherWolf is a standalone CLI, so install it with pipx —
it isolates the dependencies and puts the cypherwolf-mcp command on your PATH:
pipx install cypherwolf-mcp
Requires Python 3.10+. Dependencies are just mcp and httpx — no database
driver, no cloud SDKs.
Don't have pipx? Install it (brew install pipx on macOS, or
python3 -m pip install --user pipx) and run pipx ensurepath. On
Homebrew/externally-managed Python, pip install cypherwolf-mcp fails with a
PEP 668 error — pipx is the supported path. (A manual pip install inside an
activated virtualenv also works if you prefer.)
Upgrade later with pipx upgrade cypherwolf-mcp.
Sign in (first run)
Before the MCP server can revise queries, sign in once in a normal terminal with your Neo4j email:
cypherwolf-mcp auth
You will see the following disclosure, then be prompted for your email and a 6-digit code sent to it:
This will email a 6-digit code to verify your @neo4j.com address. Your queries and the rewrites are saved to a Neo4j-internal folder under your email for internal use only.
The resulting session token is cached at ~/.cypherwolf/credentials.json
(mode 0600) and is valid for 30 days. After it expires — or if the token is
revoked — the tool will ask you to run cypherwolf-mcp auth again.
Configure your MCP client
Point your MCP client at the cypherwolf-mcp console script (installed on your
PATH by pip).
Cursor (~/.cursor/mcp.json)
{
"mcpServers": {
"cypherwolf": {
"command": "cypherwolf-mcp"
}
}
}
Claude Code (settings.json)
{
"mcpServers": {
"cypherwolf": {
"command": "cypherwolf-mcp"
}
}
}
Restart the client after editing the config. The cypherwolf server exposes a
single tool, revise_query.
Coworker testing checklist
After the PyPI upload is live, use these steps for Neo4j coworker testing while the source repo remains private:
-
Install or upgrade the package:
pipx install cypherwolf-mcp # first time pipx upgrade cypherwolf-mcp # later upgrades
-
Sign in once:
cypherwolf-mcp authUse your
@neo4j.comemail, then paste the 6-digit code emailed to you. The package stores a 30-day session token at~/.cypherwolf/credentials.jsonwith file mode0600. -
Add the MCP server to Cursor:
{ "mcpServers": { "cypherwolf": { "command": "cypherwolf-mcp" } } }
-
Restart Cursor and confirm a
cypherwolfMCP server with one tool,revise_query, is available.For Claude Code, use the
settings.jsonsnippet in Configure your MCP client. -
Ask Cursor to call
revise_querywith a Cypher query and optional schema context. The shim is already pointed at the deployed service:https://cypherwolf-shim-ez6emjisaa-uc.a.run.app.
Expected auth behavior:
- Non-
@neo4j.comemails are rejected. - Expired or revoked sessions return an auth-required response telling you to
rerun
cypherwolf-mcp auth. - Queries and rewrites are logged to Neo4j-internal storage keyed by your email, as disclosed during sign-in.
The revise_query tool
| Arg | Required | Description |
|---|---|---|
query |
yes | The Cypher query to evaluate against corpus precedent. |
context |
no | Schema or context details (labels, indexes, cardinalities). |
neo4j_version |
no | Target Neo4j version, e.g. "5.26". |
mode |
no | Optional tuning mode, e.g. "verbose". |
Response (structured JSON):
{
"option_a": "MATCH (u:User {id: $id}) RETURN u",
"option_b": "…optional second rewrite…",
"validation_gates": ["Equality predicate on :User(id) — confirm CREATE INDEX …"],
"why": ["Corpus precedent (Slack, Fauth): …"],
"top_n": ["[0.91] Slack — Fauth: supernode pagination"],
"no_rewrite_reason": null
}
option_a/option_bare compatibility-gated precedent candidates, not guaranteed semantic equivalents of the input query. Review before applying.- Abstain is a success. When confidence is low or the corpus has no usable
precedent,
option_aisnullandno_rewrite_reasonexplains why (for example"low-confidence"or"corpus-gap"). CypherWolf never bluffs. - On an auth / rate-limit / upstream error the tool returns a structured payload
with an
errorfield and a matchingno_rewrite_reason("auth-required","rate-limited","upstream-unavailable") rather than throwing.
Configuration
| Environment variable | Default | Purpose |
|---|---|---|
CYPHERWOLF_SHIM_URL |
https://cypherwolf-shim-ez6emjisaa-uc.a.run.app |
CypherWolf service base URL. |
CYPHERWOLF_SESSION_TOKEN |
(unset) | Supply a session token directly, bypassing the on-disk cache (CI / scripted use). |
Credentials cache: ~/.cypherwolf/credentials.json (mode 0600), holding
{email, session_token, issued_at}.
Privacy
Your submitted queries and the returned rewrites are logged server-side to a Neo4j-internal storage location, keyed by your email, for internal use only. See the sign-in disclosure above.
Publishing
The package is prepared for public PyPI as cypherwolf-mcp. The source repo can
stay private during the Neo4j-only coworker-testing phase because the wheel ships
no secrets and all access control is enforced by the hosted shim's @neo4j.com
email-code gate.
Canonical publish path: PyPI API token via twine upload. The project is
live on PyPI (first release 0.1.0), so every subsequent release is a plain
twine upload authenticated with a cypherwolf-mcp-scoped API token from
~/.pypirc. Do not rely on the GitHub Release / Trusted Publishing flow —
see the note under Trusted Publishing below.
Build the artifacts
cd mcp
python -m build # produces dist/cypherwolf_mcp-<version>-py3-none-any.whl + .tar.gz
Verify a clean install in a throwaway venv:
python -m venv /tmp/cw && /tmp/cw/bin/pip install dist/cypherwolf_mcp-*.whl
/tmp/cw/bin/cypherwolf-mcp --help
/tmp/cw/bin/pip freeze | grep -iE 'google|neo4j' # must be empty
Release a new version (canonical)
- Bump the version in both
mcp/pyproject.tomlandmcp/cypherwolf/__init__.py. - Commit the change (workspace clean-trailer pattern).
- Build and upload from a committed tree:
cd mcp
rm -f dist/*
python -m build
python -m twine check dist/*
python -m twine upload dist/cypherwolf_mcp-<version>*
twine reads credentials from ~/.pypirc ([pypi], username = __token__,
password = pypi-<token>). The token must be a valid cypherwolf-mcp-scoped
API token. Never paste the token into a shell command or commit it.
After upload, verify in a clean environment:
python -m venv /tmp/cw-pypi
/tmp/cw-pypi/bin/pip install --upgrade cypherwolf-mcp
/tmp/cw-pypi/bin/cypherwolf-mcp --help
/tmp/cw-pypi/bin/pip freeze | grep -iE 'google|neo4j' # must be empty
403 "Invalid or non-existent authentication information" = the token in
~/.pypirc is stale/revoked (the account-scoped bootstrap token used for
0.1.0 was retired). Mint a fresh project-scoped token on pypi.org and update
~/.pypirc before retrying.
Trusted Publishing via GitHub Actions — NOT in use
.github/workflows/publish-mcp.yml exists but is dormant: the PyPI Trusted
Publisher for neo-gerlt/cypherwolf was never confirmed, so cutting a GitHub
Release / running the workflow will fail on the OIDC publish step. Do not
use this path. If Trusted Publishing is ever adopted, register the publisher
(repo neo-gerlt/cypherwolf, workflow publish-mcp.yml, environment pypi) on
PyPI first, confirm a dry run, then update this section.
Release checklist
-
Bump
versioninpyproject.tomlandcypherwolf/__init__.pyfor each release. -
Build from
repos/cypherwolf/mcp/and publish withtwine uploadusing a scoped PyPI token from~/.pypirc(see Release a new version (canonical) above). Do not use Trusted Publishing / GitHub Releases — that path is dormant. Do not commit any token to the repo. -
Verify a fresh install in a clean virtual environment:
python -m venv /tmp/cw && /tmp/cw/bin/pip install cypherwolf-mcp /tmp/cw/bin/cypherwolf-mcp --help /tmp/cw/bin/pip freeze | grep -iE 'google|neo4j' # must be empty
-
Repo split to
neo-gerlt/cypherwolf-mcpremains deferred (follow-on #10) and is not required to publish — apyproject.tomlrooted atmcp/ships the wheel from the monorepo today.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file cypherwolf_mcp-0.1.3.tar.gz.
File metadata
- Download URL: cypherwolf_mcp-0.1.3.tar.gz
- Upload date:
- Size: 32.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1019dec52a1cf8294ef208ce9f3ec64b08d96c1885ab8c5005a944dec0b590fe
|
|
| MD5 |
af004270dd93517909c3db9071b562ee
|
|
| BLAKE2b-256 |
e0e3b178ce04d2b4ea2567a94972e66f4f598a3c29637020f5be13caa4cd225d
|
File details
Details for the file cypherwolf_mcp-0.1.3-py3-none-any.whl.
File metadata
- Download URL: cypherwolf_mcp-0.1.3-py3-none-any.whl
- Upload date:
- Size: 22.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fee7262f81a0d65929519837dabfe8119f5ecc98c2b9ebc538683d8e58a36b46
|
|
| MD5 |
870e0cf1af5a5d2c616f6b970d14a1d5
|
|
| BLAKE2b-256 |
543d17d56a5924ea17c29a13424a5b88a845161372efff2964a30566ac244d36
|