Neo4j MCP Canary — The canary goes first so the rest of us know what's coming

Neo4j MCP Canary is a fast-moving, experimental release of the Neo4j MCP server for customers who want to explore emerging capabilities before they are considered for the official server.

Built on the source of the official Model Context Protocol (MCP) server for Neo4j, this variant is here for exploring potential new capabilities with experimentation.

As it is a labs project, be aware that:

• It is not supported
• It may contain breaking changes between its own releases and with the official Neo4j MCP server
• It should be tested before using

Do not assume the canary will work for your situation. Test first.

Prerequisites

• A running Neo4j database instance; options include Aura, Neo4j Desktop, or self-managed.
• APOC plugin installed in the Neo4j instance (required — get-schema uses apoc.meta.schema).
• Any MCP-compatible client (e.g. VSCode with MCP support).

⚠️ Known Issue: Neo4j 5.26.18 has a bug in APOC that causes the get-schema tool to fail. This is fixed in 5.26.19 and above. If you're on 5.26.18, please upgrade. See #136 for details.

Startup Checks & Adaptive Operation

The server performs several checks to ensure your environment is correctly configured.

STDIO Mode — Mandatory Requirements In STDIO mode, the server verifies the following. If any check fails (e.g. invalid configuration, incorrect credentials, missing APOC), the server will not start:

• A valid connection to your Neo4j instance.
• The ability to execute queries.
• The presence of the APOC plugin.
• Minimum version check for use of Query API to communicate with the datatbase

HTTP Mode — Verification Skipped In HTTP mode, startup verification checks are skipped because credentials come from per-request auth headers. The server starts immediately without connecting to Neo4j. The one exception is Query API mode: its minimum-version check runs at startup in both transport modes, since it only needs an unauthenticated GET and doesn't depend on per-request credentials.

Optional Requirements If an optional dependency is missing, the server starts in adaptive mode. For instance, if the Graph Data Science (GDS) library is not detected, the server still launches but automatically disables GDS-dependent tools such as list-gds-procedures. All other tools remain available.

Installation (Binary)

Releases: Canary MCP releases

1. Download the archive for your OS/arch.
2. Extract and place neo4j-mcp-canary on your PATH.

Mac / Linux:

On Mac, you may be warned the first time you try to run the binary. If so, approve it via System Settings → Privacy & Security.

chmod +x neo4j-mcp-canary
sudo mv neo4j-mcp-canary /usr/local/bin/

Windows (PowerShell / cmd):

move neo4j-mcp-canary.exe C:\Windows\System32

Verify the installation:

neo4j-mcp-canary -v

Should print the installed version.

Building from Source

Requires Go 1.26+ (see go.mod).

Build for your current platform with Task:

task build

This produces bin/neo4j-mcp-canary. Without Task, the equivalent is:

go build -C cmd/neo4j-mcp -o ../../bin/

Cross-compiling for macOS / Linux

Cross-compile by setting GOOS/GOARCH and disabling cgo (the codebase is pure Go, so CGO_ENABLED=0 produces a fully static binary with no runtime dependencies on the target machine):

CGO_ENABLED=0 GOOS=darwin  GOARCH=amd64 go build -C cmd/neo4j-mcp -o ../../dist/neo4j-mcp-canary_darwin_amd64
CGO_ENABLED=0 GOOS=darwin  GOARCH=arm64 go build -C cmd/neo4j-mcp -o ../../dist/neo4j-mcp-canary_darwin_arm64
CGO_ENABLED=0 GOOS=linux   GOARCH=amd64 go build -C cmd/neo4j-mcp -o ../../dist/neo4j-mcp-canary_linux_amd64
CGO_ENABLED=0 GOOS=linux   GOARCH=arm64 go build -C cmd/neo4j-mcp -o ../../dist/neo4j-mcp-canary_linux_arm64

To stamp a version into the binary (-v / --version), pass an ldflags override — this is what the release pipeline does for tagged builds:

go build -C cmd/neo4j-mcp -o ../../dist/neo4j-mcp-canary \
  -ldflags "-X 'main.Version=$(git rev-parse --short HEAD)'"

Without it, Version defaults to "development", which also disables telemetry regardless of NEO4J_TELEMETRY (see Telemetry).

Official multi-platform release archives (including Windows) are built by GoReleaser per .goreleaser.yaml — see Installation (Binary) to download those instead of building locally.

MCP Transport Modes

The Neo4j MCP Canary server supports two communication transport modes

• STDIO (default): Standard MCP communication via stdin/stdout for desktop clients (Claude Desktop, VSCode).
• HTTP: RESTful HTTP server with per-request Bearer token or Basic Authentication for web-based clients and multi-tenant scenarios. Where the standard Authorization header cannot be used, a custom header name can be configured.

Key Differences

See the Client Setup Guide for configuration instructions for both modes. HTTP mode also supports an alternative multi-instance configuration, where one server fronts several Neo4j instances at once — see docs/MULTI_INSTANCE.md.

Unauthenticated MCP Client Requests

By default, there are four requests a MCP client can send without authentication when using HTTP(S) transport. Some integrations (AWS AgentCore, AWS Gateway, etc.) rely on this as an initial health-check mechanism:

• ping
• initialize
• tools/list
• notifications/initialize

If you do not need these, enforce authentication individually via the variables below.

TLS/HTTPS Configuration

When using HTTP transport, enable TLS for secure communication via the variables below.

Security Configuration

• Minimum TLS Version: TLS 1.2 (TLS 1.3 negotiated when available)
• Cipher Suites: Go's secure default cipher suites
• Default Port: Automatically uses 443 when TLS is enabled

Example

export NEO4J_URI="bolt://localhost:7687"
export NEO4J_TRANSPORT_MODE="http"
export NEO4J_MCP_HTTP_TLS_ENABLED="true"
export NEO4J_MCP_HTTP_TLS_CERT_FILE="/path/to/cert.pem"
export NEO4J_MCP_HTTP_TLS_KEY_FILE="/path/to/key.pem"

neo4j-mcp-canary
# Server listens on https://127.0.0.1:443 by default

Production Usage: use certificates from a trusted CA (Let's Encrypt, your organisation's CA, etc.) for production deployments.

For detailed instructions on certificate generation, TLS testing, and production deployment, see CONTRIBUTING.md.

Configuration Options

The neo4j-mcp-canary server is configured via environment variables, CLI flags, and/or an optional config file. CLI flags take precedence over environment variables, which take precedence over an optional config file.

Environment Variables

Core connection and behaviour:

Connecting via the Query API instead of Bolt

NEO4J_URI's scheme determines which wire protocol the server uses to talk to Neo4j — no separate flag is needed:

• bolt://, bolt+s://, neo4j://, neo4j+s://, etc. → the Bolt driver (default, unchanged behaviour).
• http:// or https:// → the Neo4j Query API, Neo4j's HTTP-based query interface. Useful for deployments that only expose HTTP or otherwise prefer not to use Bolt.

Query API mode requires Neo4j 2026.07 or newer (calendar-versioned releases) or 5.26-aura or newer (classic-versioned Aura releases only — a bare classic version with no -aura suffix is not supported, since self-managed classic servers predate the typed-JSON media type version this server's Query API client depends on). This floor is one release past the Query API's own general availability (2026.06): read-cypher's write-query rejection depends on the queryType field in the query response, which Neo4j only introduced in 2026.07 — a 2026.06 server has no reliable signal to classify a query as read-only before running it. The server checks the connected instance's reported version against this floor at startup (via an unauthenticated GET to the base URI) and refuses to start if it's too old, with an error naming the version it found and the minimum required.

NEO4J_USERNAME/NEO4J_PASSWORD and per-request Basic/Bearer credentials work the same way in Query API mode as they do for Bolt — see Transport Modes and Authentication Methods (HTTP Mode).

Cypher execution safeguards (see Cypher Execution Safeguards):

HTTP transport, TLS, and auth (see tables above).

CLI Flags

You can override any environment variable using CLI flags:

neo4j-mcp-canary \
  --neo4j-uri "bolt://localhost:7687" \
  --neo4j-username "neo4j" \
  --neo4j-password "password" \
  --neo4j-database "neo4j" \
  --neo4j-read-only false \
  --neo4j-telemetry true

Available flags:

Connection & behaviour

• --neo4j-uri — overrides NEO4J_URI
• --neo4j-username — overrides NEO4J_USERNAME
• --neo4j-password — overrides NEO4J_PASSWORD
• --neo4j-database — overrides NEO4J_DATABASE
• --neo4j-read-only — overrides NEO4J_READ_ONLY (true / false)
• --neo4j-mcp-enabled-tools — overrides NEO4J_MCP_ENABLED_TOOLS (comma-separated tool names)
• --neo4j-mcp-enabled-tool-categories — overrides NEO4J_MCP_ENABLED_TOOL_CATEGORIES (comma-separated categories)
• --neo4j-telemetry — overrides NEO4J_TELEMETRY (true / false)
• --neo4j-schema-sample-size — overrides NEO4J_SCHEMA_SAMPLE_SIZE
• --neo4j-output-format — overrides NEO4J_OUTPUT_FORMAT (json / toon / markdown)
• --neo4j-mcp-embedding-provider — overrides NEO4J_MCP_EMBEDDING_PROVIDER
• --neo4j-mcp-embedding-configuration — overrides NEO4J_MCP_EMBEDDING_CONFIGURATION (comma-separated key=value pairs)

Cypher execution safeguards

• --neo4j-cypher-max-rows — overrides NEO4J_CYPHER_MAX_ROWS (0 disables)
• --neo4j-cypher-max-bytes — overrides NEO4J_CYPHER_MAX_BYTES (0 disables)
• --neo4j-cypher-timeout — overrides NEO4J_CYPHER_TIMEOUT (seconds; 0 disables)
• --neo4j-cypher-max-estimated-rows — overrides NEO4J_CYPHER_MAX_ESTIMATED_ROWS (0 disables)

Transport / HTTP

• --neo4j-transport-mode — stdio or http
• --neo4j-http-host — overrides NEO4J_MCP_HTTP_HOST
• --neo4j-http-port — overrides NEO4J_MCP_HTTP_PORT
• --neo4j-http-allowed-origins — overrides NEO4J_MCP_HTTP_ALLOWED_ORIGINS (comma-separated CORS origins)
• --neo4j-http-tls-enabled — overrides NEO4J_MCP_HTTP_TLS_ENABLED
• --neo4j-http-tls-cert-file — overrides NEO4J_MCP_HTTP_TLS_CERT_FILE
• --neo4j-http-tls-key-file — overrides NEO4J_MCP_HTTP_TLS_KEY_FILE
• --neo4j-http-auth-header-name — overrides NEO4J_HTTP_AUTH_HEADER_NAME
• --neo4j-mcp-http-tools-header-name — overrides NEO4J_MCP_HTTP_TOOLS_HEADER_NAME
• --neo4j-mcp-http-tool-categories-header-name — overrides NEO4J_MCP_HTTP_TOOL_CATEGORIES_HEADER_NAME
• --neo4j-http-allow-unauthenticated-ping — overrides NEO4J_HTTP_ALLOW_UNAUTHENTICATED_PING
• --neo4j-http-allow-unauthenticated-tools-list — overrides NEO4J_HTTP_ALLOW_UNAUTHENTICATED_TOOLS_LIST
• --neo4j-http-allow-unauthenticated-initialize — overrides NEO4J_HTTP_ALLOW_UNAUTHENTICATED_INITIALIZE
• --neo4j-http-allow-unauthenticated-notifications-initialize — overrides NEO4J_HTTP_ALLOW_UNAUTHENTICATED_NOTIFICATIONS_INITIALIZE

Run neo4j-mcp-canary --help to see the complete list with descriptions.

Configuration File

As a lowest-priority alternative to environment variables, neo4j-mcp-canary can read configuration from an optional JSON or YAML file:

neo4j-mcp-canary --config-file /etc/neo4j-mcp/config.yaml
# or
NEO4J_CONFIG_FILE=/etc/neo4j-mcp/config.yaml neo4j-mcp-canary

Keys are the lower-cased form of the environment variable they correspond to:

neo4j_uri: bolt://localhost:7687
neo4j_username: neo4j
neo4j_password: password
neo4j_read_only: false
neo4j_transport_mode: http
neo4j_http_tls_enabled: true
neo4j_cypher_max_rows: 500

The equivalent JSON is also accepted (.json extension). Only scalar values (strings, numbers, booleans) are supported for every key except one — a nested object or list under any other key is a startup error. Values from CLI flags or environment variables always take precedence over the config file; a --config-file that fails to read or parse is a startup error.

The one exception is neo4j_instances, a list of Neo4j instance definitions that turns on multi-instance HTTP mode, letting one server front several Neo4j instances at once, each reachable at its own URL path. It's configurable only via the config file — see docs/MULTI_INSTANCE.md for the full config shape, per-instance auth types, and how a client selects an instance.

Adding a new configuration parameter to the server (env var + CLI flag + config-file key, all at once) means adding one entry to the fields slice in internal/config/schema.go — see that file's doc comments for the shape.

Response Format (JSON, TOON, or Markdown)

Tool responses (every tool in the table above) are rendered as JSON by default. Set NEO4J_OUTPUT_FORMAT (or --neo4j-output-format) to toon or markdown to render them differently instead:

neo4j-mcp-canary --neo4j-output-format toon
# or
NEO4J_OUTPUT_FORMAT=toon neo4j-mcp-canary

A read-cypher result as JSON:

{
  "rows": [
    { "name": "Alice", "age": 30 },
    { "name": "Bob", "age": 25 }
  ],
  "rowCount": 2,
  "truncated": false
}

The same result as TOON (Token-Oriented Object Notation) — a compact, still human-readable format that cuts LLM token usage versus JSON, especially for the tabular row shapes these tools return:

rowCount: 2
rows[2]{age,name}:
  30,Alice
  25,Bob
truncated: false

The same result as markdown — a uniform array of flat rows renders as a table, nested/non-uniform data (e.g. get-schema's output) renders as nested bullets:

- **rowCount**: 2
- **rows**:
| age | name |
| --- | --- |
| 30 | Alice |
| 25 | Bob |
- **truncated**: false

markdown is a complement to toon, not a strict upgrade over it: independent benchmarks on tabular data found Markdown tables scoring higher accuracy than TOON despite using more tokens, while TOON still wins on raw token count. Prefer toon when token budget matters most; prefer markdown when result accuracy matters most.

An invalid value falls back to json with a warning on stderr, the same way NEO4J_LOG_FORMAT does.

Structured output (structuredContent / outputSchema)

Every tool call result also carries MCP's structured-output extension: alongside the text block described above (in whichever format NEO4J_OUTPUT_FORMAT selects), the result's structuredContent field always carries the same data as canonical JSON, matched by an advertised outputSchema on the tool definition. A client that wants to consume results programmatically can read structuredContent directly instead of re-parsing the text block, regardless of which text format is configured.

Because structuredContent duplicates the payload already in the text block, read-cypher/write-cypher enforce NEO4J_CYPHER_MAX_BYTES as a combined budget: the byte cap actually applied during streaming is half the configured value, so text+structured together still stay under the ~900 KB/1 MB intent described below rather than doubling it.

Cypher Execution Safeguards

read-cypher and write-cypher are protected by four layered safeguards that together keep an overeager LLM from hanging the MCP transport or exhausting the database. Each layer catches a different failure mode; together they act as defence in depth.

Set any value to 0 to disable that specific layer.

Truncation envelope

When either the row cap or the byte cap fires, the tool returns the rows it has already collected plus a truncation envelope:

{
  "rows": [ /* ... */ ],
  "rowCount": 1000,
  "truncated": true,
  "truncationReason": "rows",
  "maxRows": 1000,
  "hint": "Results were truncated at 1000 rows. Add a LIMIT clause or a more selective filter and retry for a complete result."
}

Callers (including LLM agents) can read truncated / truncationReason / hint programmatically and retry with a tighter query rather than seeing an opaque transport-level failure.

Timeout and cancellation errors

When NEO4J_CYPHER_TIMEOUT fires, the tool returns a classified error that names the configured limit and offers tool-specific remediation (bound variable-length patterns, add WHERE filters, or LIMIT for read-cypher; reduce batch size, narrow the MATCH, or use apoc.periodic.iterate for write-cypher). Caller cancellation (as distinct from timeout) surfaces as a concise cancelled message without remediation guidance.

Planner estimate refusal

The planner-estimate guard reads the root EstimatedRows of an EXPLAIN plan before the query runs. Because Neo4j folds LIMIT into the root estimate, a legitimate MATCH ... LIMIT 100 query passes cleanly with an estimate of ~100, while a bare MATCH on a multi-million-row label is refused before it starts.

Authentication Methods (HTTP Mode)

When using HTTP transport mode, the Neo4j MCP Canary server supports two authentication methods to accommodate different deployment scenarios. (This section covers single-instance HTTP mode; multi-instance mode has its own per-instance auth types, including server-verified Bearer tokens — see docs/MULTI_INSTANCE.md.)

Bearer Token Authentication

Bearer token authentication enables seamless integration with Neo4j Enterprise Edition and Neo4j Aura environments that use SSO/OAuth/OIDC for identity management. This method is ideal for:

• Enterprise deployments with centralised identity providers (Okta, Azure AD, etc.)
• Neo4j Aura databases configured with SSO
• Organisations requiring OAuth 2.0 compliance
• Multi-factor authentication scenarios

Example:

curl -X POST http://localhost:8080/mcp \
  -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..." \
  -H "Content-Type: application/json" \
  -d '{"jsonrpc":"2.0","method":"tools/list","id":1}'

The bearer token is obtained from your identity provider and passed to Neo4j for authentication. The MCP server acts as a pass-through, forwarding the token to Neo4j's authentication system.

Basic Authentication

Traditional username/password authentication suitable for:

• Neo4j Community Edition
• Development and testing environments
• Direct database credentials without SSO

Example:

curl -X POST http://localhost:8080/mcp \
  -u neo4j:password \
  -H "Content-Type: application/json" \
  -d '{"jsonrpc":"2.0","method":"tools/list","id":1}'

Client Configuration

To configure MCP clients (VSCode, Claude Desktop, etc.) to use the Neo4j MCP Canary server, see:

📘 Client Setup Guide – Complete configuration for STDIO and HTTP modes.

Tools & Usage

Provided tools:

Selecting which tools are exposed

Every tool belongs to exactly one category (cypher, gds, feedback, or search, per the table above) and carries a label — its MCP title annotation (e.g. "Read Cypher"), shown to clients that display a friendly tool name.

Tool selection can be narrowed in two ways, which combine with the existing NEO4J_READ_ONLY/GDS-availability/search-version filtering (a selection can only narrow the set further, never re-enable a tool those filters already excluded):

Statically, at startup, via NEO4J_MCP_ENABLED_TOOLS and/or NEO4J_MCP_ENABLED_TOOL_CATEGORIES (comma-separated; a tool is kept if it matches either list — see Configuration Options):

# Only expose the two Cypher read tools:
export NEO4J_MCP_ENABLED_TOOLS="read-cypher,get-schema"

# Only expose the cypher category (equivalent to the above plus write-cypher):
export NEO4J_MCP_ENABLED_TOOL_CATEGORIES="cypher"

Per-request, in HTTP mode, via the X-MCP-Tools and X-MCP-Tool-Categories headers (names configurable via NEO4J_MCP_HTTP_TOOLS_HEADER_NAME / NEO4J_MCP_HTTP_TOOL_CATEGORIES_HEADER_NAME). A request that omits both headers sees the full statically-enabled tool set as usual; a request that sets either header sees only the matching tools for that single request, and calling an excluded tool fails the same way calling a nonexistent one would:

curl -X POST https://your-server/mcp \
  -H "Authorization: Basic <credentials>" \
  -H "X-MCP-Tool-Categories: gds" \
  -H "Content-Type: application/json" \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/list"}'

Read-only mode flag

Enable read-only mode by setting NEO4J_READ_ONLY=true (accepted: true / false; default: false).

You can also use the CLI flag:

neo4j-mcp-canary \
  --neo4j-uri "bolt://localhost:7687" \
  --neo4j-username "neo4j" \
  --neo4j-password "password" \
  --neo4j-read-only true

When enabled, write tools (e.g. write-cypher) are not exposed to clients.

Query classification

read-cypher prepends EXPLAIN to the caller's query to classify it as read or write before executing. Consequences:

• Write operations (CREATE, MERGE, DELETE, SET, REMOVE, ...) — rejected with a message directing the caller to write-cypher.
• Schema/DDL operations (CREATE INDEX, DROP CONSTRAINT, ...) — rejected, same message.
• Admin commands (SHOW USERS, SHOW DATABASES, ...) — rejected, same message.
• EXPLAIN prefix — rejected with a message pointing at explain-cypher for the query plan, or profile-cypher for a profiled plan with runtime statistics.
• PROFILE prefix — rejected with a message pointing at profile-cypher, which executes the query and returns both the results and a profiled plan. write-cypher also rejects an EXPLAIN/PROFILE prefix, for the same reason — see Query planning and profiling.
• Read-only SHOW commands (SHOW INDEXES, SHOW CONSTRAINTS, SHOW PROCEDURES, SHOW FUNCTIONS) — allowed.

If the wrapped query produces a syntax error, the server strips the internal EXPLAIN prefix from the error text, column offset, and caret alignment before returning — so the error reads as if the caller's original query had been submitted directly.

Query planning and profiling

explain-cypher and profile-cypher cover the query-tuning workflow read-cypher/write-cypher deliberately don't handle: explain-cypher returns the planner's plan tree for any statement — read or write — without executing it, since EXPLAIN never runs the query. profile-cypher executes the statement and returns both the results and a profiled plan with per-operator runtime statistics (dbHits, rows, time, page cache hit ratio). Neither tool accepts a query already prefixed with EXPLAIN/PROFILE — each adds its own prefix internally and rejects a caller-supplied one with a message pointing at the other tool if that's what was actually wanted.

Schema management tools

list-constraints-and-indexes, create-constraint, drop-constraint, create-index, and drop-index manage constraints and indexes via structured fields only — none of them accept or return raw Cypher. create-constraint supports UNIQUENESS, KEY, and PROPERTY_EXISTENCE constraints (KEY/PROPERTY_EXISTENCE require Enterprise Edition; Community Edition rejects them at creation time — retrying won't help). create-index supports RANGE, TEXT, POINT, and LOOKUP indexes; vector and fulltext indexes are created via the search category's create-vector-index/create-fulltext-index instead. drop-index works for any index type, including vector and fulltext ones. Every create-* tool always includes IF NOT EXISTS/IF EXISTS in the generated statement, so retrying with the same arguments is safe; when name is omitted, a generated name is returned in the response for later use with the matching drop-* tool.

Vector and full-text search tools

The search category — vector-search, fulltext-search, create-vector-index, create-fulltext-index, set-vector-property, check-embedding-dimensions — surfaces Cypher 25's SEARCH clause through structured fields only; no tool in this category accepts or returns raw Cypher. vector-search/fulltext-search auto-detect the target node label or relationship type from the index itself, so the caller only needs the index name. vector-search's filters only work on properties registered as filterable at index-creation time via create-vector-index's filterableProperties — filtering on any other property is a hard Neo4j limitation, not a tool restriction. set-vector-property takes either a caller-supplied embedding (vector) or raw text to embed — the latter only works when the connected Neo4j instance has an embedding provider configured, via NEO4J_MCP_EMBEDDING_PROVIDER/NEO4J_MCP_EMBEDDING_CONFIGURATION in single-instance mode (STDIO or single-instance HTTP) or via each entry's own embedding block in multi-instance HTTP mode (see Multi-Instance HTTP Mode for the full provider/required-key table, which applies to both). Who actually generates it depends on the provider: openai is generated by this MCP server itself via a direct HTTP call (its baseUrl config key can redirect this to a local OpenAI-compatible server like LM Studio or Ollama, with no Neo4j-side involvement at all), while azure-openai/vertexai/bedrock-titan are generated by Neo4j's own GenAI plugin (ai.text.embed) instead, reusing the auth schemes it already implements. Either way, if a matching vector index already exists, the resulting vector's dimensions are checked against it before writing, and check-embedding-dimensions lets a caller validate a provider/model against an index up front without writing anything.

This category requires a server on calendar version >= 2026.09.0 or classic Aura >= 5.27-aura (native full-text SEARCH-clause support shipped in Neo4j's 2026.09 release; vector search alone works from 2026.01, but the whole category is gated behind the higher floor for consistency). Below that floor, the six tools are automatically excluded from tools/list rather than failing at call time — the same way list-gds-procedures is excluded when GDS isn't installed.

Response format for read-cypher / write-cypher

Driver types are wrapped in camelCase JSON shapes matching Cypher conventions:

• Nodes: { "elementId": "...", "labels": [...], "properties": {...} }
• Relationships: { "elementId": "...", "startElementId": "...", "endElementId": "...", "type": "...", "properties": {...} }
• Paths: { "nodes": [...], "relationships": [...] }
• Points: { "x": ..., "y": ..., "srid": ... } (and z for 3D)
• Date / Time / DateTime / LocalTime / LocalDateTime / Duration: ISO 8601 strings

Deprecated numeric id / startId / endId identifiers are not surfaced — elementId / startElementId / endElementId are the only identifiers returned.

Feedback

give-feedback lets an agent submit free-text feedback about the MCP server itself — positive or negative — as a single feedback string argument, capped at 300 characters (enforced both in the advertised tool schema and by the handler, in case a client doesn't validate the schema before sending). It's for feedback on the server's tools, behaviour, or documentation, not for reporting Cypher/database errors.

Feedback is sent as a Mixpanel event alongside the server's other telemetry, so it is only recorded when telemetry is enabled (see Telemetry) — the tool call itself always succeeds either way.

Usage Guidance

Lessons from canary testing that help an LLM (or a human) get the most out of read-cypher:

1. Aggregate in the database. count, sum, avg, collect, reduce, percentileCont, stDev, and similar reductions collapse to one row and are unaffected by the row cap. A query like UNWIND range(1, 50000) AS i RETURN sum(i) runs cleanly; the same range streamed row-by-row is truncated at the row cap.
2. Always use LIMIT for exploratory queries. The row cap will truncate bare MATCH returns; the truncation envelope's hint field will tell the caller to add a LIMIT. Prefer a LIMIT you picked over one the server imposed.
3. Narrow the RETURN projection for wide nodes. When a record carries many properties (e.g. a full Company node with 19 fields), the byte cap fires before the row cap. Return only the fields you need (RETURN c.name, c.companyNumber) rather than the whole node.
4. Use parameters, including nested maps. Parameter placeholders ($name) are bound from the params object; nested access works ($config.thresholds.pr). Missing required parameters produce a clear ParameterMissing error; extra parameters are silently ignored.
5. Be explicit about types in comparisons. Cross-type comparisons like t.amount > "foo" evaluate to null and silently filter everything out — no error, just an empty result set. Validate incoming parameter types on the caller side when the result shape surprises you.
6. SHOW INDEXES / SHOW CONSTRAINTS are allowed. Useful before writing a query that depends on an index, or for debugging why a match is slow.
7. EXPLAIN and PROFILE are not exposed on read-cypher/write-cypher. Runaway-query protection is already handled by the planner-estimate guard and execution timeout. Use explain-cypher for the query plan, or profile-cypher for a profiled plan with runtime stats.
8. Watch for duplicated payloads when returning paths. RETURN p, nodes(p), relationships(p) triples the serialised payload. Return the path or its components, not both.
9. Long-running queries return a classified error. When NEO4J_CYPHER_TIMEOUT fires, the error names the timeout value and suggests remediation (bound variable-length patterns, add WHERE filters, use LIMIT) instead of a raw context deadline exceeded from the driver.
10. OPTIONAL MATCH for missing data. When looking up by ID where some IDs may not exist, OPTIONAL MATCH returns nulls for misses instead of dropping rows — better for batch lookups.
11. Defaults are calibrated, not arbitrary. 1000 rows / ~900 KB / 30s / 1M planner estimate cover the overwhelming majority of exploratory and production queries. Increase them for bulk export workloads; reduce them when serving high-traffic agent deployments.

Example Natural Language Prompts

Prompts to try in Copilot or any other MCP client:

• "What does my Neo4j instance contain? List all node labels, relationship types, and property keys."
• "Find all Person nodes and show their top relationships, limited to 50 results."
• "What indexes and constraints exist on my database?"
• "Summarise the transaction graph: total count, average amount, and the top 5 customers by PageRank."

Security tips

• Use a restricted Neo4j user for exploration.
• Review LLM-generated Cypher before executing it in production databases.
• Keep NEO4J_READ_ONLY=true for any deployment that shouldn't mutate the graph.
• Leave the Cypher safeguards at their defaults unless you have a specific reason to change them.

Logging

The server uses structured logging with support for multiple log levels and output formats.

Configuration

Log Level (NEO4J_LOG_LEVEL, default: info)

Controls verbosity. Supports all MCP log levels: debug, info, notice, warning, error, critical, alert, emergency.

Log Format (NEO4J_LOG_FORMAT, default: text)

• text — human-readable (default)
• json — structured JSON (useful for log aggregation)

Telemetry

By default, neo4j-mcp-canary collects anonymous usage data to help improve the product. This includes information such as the tools being used, the operating system, and CPU architecture. No personal or sensitive information is collected.

To disable telemetry, set NEO4J_TELEMETRY=false (accepted: true / false; default: true). You can also use the --neo4j-telemetry CLI flag.

Documentation

📘 Client Setup Guide – Configure VSCode, Claude Desktop, and other MCP clients (STDIO and HTTP modes) 📚 Contributing Guide – Contribution workflow, development environment, mocks & testing

Issues / feedback: open a GitHub issue with reproduction details (omit sensitive data).