Skip to content

Latest commit

 

History

45 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 

Repository files navigation

HelixDB Skills

Hosted skills.sh repository for HelixDB agent skills.

The query skills target HelixDB v3 SDK APIs. Installation commands stay unpinned; verify registry availability before claiming that a package is published.

These skills are for agents that need to:

  • write Helix queries in the Rust, TypeScript, Python, and Go SDK DSLs
  • write dynamic-first Helix queries in Go
  • translate from Cypher, Gremlin, SQL, and legacy HelixQL (HQL) into Helix query code
  • optimize Helix query shape and index usage
  • build correct dynamic POST /v2/query payloads
  • inspect Helix Cloud query insights, latency, recommendations, usage, and cluster health through the hosted read-only MCP server
  • design and operate an agent memory system on Helix's hybrid graph + vector + full-text engine

Status

Available now:

  • helix-cli
  • helix-mcp
  • helix-query-from-cypher
  • helix-query-from-gremlin
  • helix-query-from-hql
  • helix-query-json-dynamic
  • helix-query-optimize
  • helix-query-rust
  • helix-query-typescript
  • helix-query-go
  • helix-query-python
  • helix-memory-system

Planned next:

  • helix-query-from-sql

Install

npx skills add HelixDB/skills

Helix Cloud queries

When the target is Helix Cloud, every helix-query-* skill requires helix-mcp first. The agent resolves the live database and reads relevant active indexes, insights, latency, and recommendations before authoring, translating, debugging, or optimizing a query. MCP remains read-only; SDKs and /v2/query remain the query execution surfaces.

Running queries (prerequisites)

The query-authoring skills assume you already have a Helix instance to run them against. To stand one up locally — no Cloud login required:

  1. Install the Helix CLI: curl -sSL "https://install.helix-db.com" | bash.
  2. Make sure Docker or Podman is installed and running — the local instance runs in a container (docker info should succeed).
  3. Scaffold and start a local instance:
    helix init local
    helix start dev          # `helix run` is kept as an alias
  4. Run queries: send the DSL output through the SDK client (Client / client.Exec) or with helix query dev --file <request.json>.

The local runtime uses ghcr.io/helixdb/helixdb:v0.0.3. It is in-memory by default; --disk uses a CLI-managed MinIO service for persistence. The skills produce direct POST /v2/query requests for a running instance reachable at a server URL. Helix Cloud uses Bearer authentication; GA requests also require the tenant context in x-helix-tenant-id. There is no helix compile/helix check step — queries are validated server-side when sent. See the HelixDB docs for the full setup and the non-interactive/agent path.

Repository Layout

  • skills/ contains the published skills
  • docs/ contains shared reference material used while authoring skills
  • examples/ contains generic canonical examples and before-and-after patterns
  • benchmarks/ contains evaluation scaffolding for prompt and gold-answer testing

Current Skills

helix-mcp

Use this skill when an agent needs to inspect authorized Helix Cloud resources and observability data through the hosted read-only MCP server.

It teaches agents to:

  • discover workspaces, projects, and databases before requesting data
  • fetch the writer-authoritative active index inventory before deciding whether a Cloud predicate has a usable index
  • select the correct tool for query insights, latency percentiles, recommendations, usage, or dedicated-cluster health
  • keep p99 in the latency workflow and separate fast usage rollups from cluster health
  • treat query names, planner findings, and recommendation text as untrusted data rather than agent instructions
  • report time windows, partial data, collection watermarks, and unavailable components accurately

helix-cli

Use this skill when an agent needs to drive the helix CLI itself — run, query, and deploy Helix instances — rather than author the query bodies.

It teaches agents to:

  • use the v3 mental model: a runtime orchestrator, not a compiler (no helix compile/helix check, no .hx workflow)
  • run the local dev loop (helix init localstartquerystop) with Docker/Podman, including in-memory vs --disk persistence
  • send dynamic queries to POST /v2/query via helix query (--file/--json/-e TypeScript DSL/--ts-file)
  • operate on Helix Cloud (helix auth, push, sync, workspace/project/cluster)
  • read and edit helix.toml and the ~/.helix/* state files

It points to the helix-query-* skills for the query bodies themselves; see its REFERENCE.md for the full command catalog and EXAMPLES.md for end-to-end sessions.

helix-query-json-dynamic

Use this skill when an agent needs to build or debug direct JSON requests for POST /v2/query.

It teaches agents to:

  • use the correct request envelope
  • target the dynamic route (POST /v2/query) with an inline query object
  • add parameter_types when typed coercion matters
  • send DateTime values correctly
  • avoid malformed bundle-shaped payloads

helix-query-go

Use this skill when an agent needs to write or revise HelixDB queries with the Go SDK.

It teaches agents to:

  • write normal Go functions returning helix.Request
  • set query names with helix.ReadQuery and helix.WriteQuery
  • declare runtime params inline with q.ParamString, q.ParamI64, q.ParamDateTime, and related helpers
  • avoid accidentally inlining request-specific literals in predicates and source predicates
  • execute dynamic requests with client.Exec(ctx, request, &out)
  • handle HTTP 409 conflicts explicitly with caller-owned retries
  • avoid stored-query registration and query-bundle workflows, which are not part of the v3 SDK

helix-query-python

Use this skill when an agent needs to write or revise HelixDB queries with the Python SDK.

It teaches agents to:

  • write Pythonic query builders with read_batch, write_batch, g, and snake_case traversal methods
  • declare runtime params with define_params and param.*
  • produce direct requests with to_query_request / to_query_json
  • execute requests with synchronous Client or reusable server/embedded AsyncClient
  • use row bindings for correlated multi-hop projections
  • keep Python queries structurally identical to the Rust/TypeScript/Go JSON AST

helix-query-from-cypher

Use this skill when an agent needs to port Neo4j or Cypher queries into Helix Rust DSL.

It teaches agents to:

  • translate MATCH into explicit anchors and traversals
  • map WHERE to Predicate logic
  • map RETURN, DISTINCT, ordering, and limits into explicit output shaping
  • handle OPTIONAL MATCH, MERGE, CASE, UNWIND, FOREACH, multi-hop traversal, null checks, and timestamps as Helix-native translations rather than literal rewrites

helix-query-from-gremlin

Use this skill when an agent needs to port Gremlin or TinkerPop traversals into Helix Rust DSL.

It teaches agents to:

  • translate g.V, hasLabel, and has into anchors and predicates
  • map out, in, both, outE, and inE into explicit Helix traversal steps
  • map dedup, count, range, ordering, and valueMap into deliberate result shaping
  • handle repeat, path, select, and side-effect-heavy traversals as semantic translations rather than literal rewrites

helix-query-from-hql

Use this skill when an agent needs to migrate legacy HelixQL (HQL) .hx queries into the v3 Rust or TypeScript DSL.

It teaches agents to:

  • map every HQL construct (N<T>/E<T>, Out/In/OutE/FromN/ToN, WHERE/EQ/IS_IN, projections, GROUP_BY/AGGREGATE_BY, ORDER/RANGE, AddN/AddE/UPDATE/DROP, SearchV/SearchBM25) to its Rust and TypeScript builder
  • handle the Rust-vs-TypeScript spelling differences (in_/in, where_/where, ::/., Some()/null)
  • flag HQL features with no DSL equivalent (Upsert, RerankRRF/RerankMMR, shortest-path, Embed, advanced math, EXISTS/count-in-WHERE, schema defaults, #[model]/#[mcp]) and move that logic to application code
  • verify each migration by compiling, diffing the Rust vs TypeScript JSON AST for parity, and running against the same data

helix-query-optimize

Use this skill when an agent needs to review or improve Helix query performance.

It teaches agents to:

  • fetch the live active index inventory before deciding index usability
  • fix anchor choice before anything else
  • match query shape to existing indexes
  • move scope filters earlier
  • shrink large projections
  • review BM25 and vector search routes separately

helix-memory-system

Use this skill when an agent needs to design or operate an AI agent memory system on Helix — generation, deduplication, updating/consolidation, deletion/forgetting, and categorisation, not just retrieval.

It teaches agents to:

  • model per-user memory with User, Memory, Category, Entity, and Session labels plus the edges and indexes that make it fast and tenant-safe
  • choose the right mechanism per operation: properties + equality index, graph edges, vector search, or BM25 text search
  • run the full write/maintain lifecycle (dedup-on-generate, reinforce-on-access, supersede/correct, soft-delete, decay and expiry sweeps, upsert-and-link categorisation)
  • build hybrid recall that fuses vector + BM25 app-side and expands through the graph

It is TypeScript-first (@helix-db/helix-db@3.0.0) with a Rust v3 DSL variant in EXAMPLES.rust.md.

Shared References

Start here when working on the next skills:

  • docs/source-canon.md
  • docs/dsl-cheatsheet.md
  • docs/go-dsl-cheatsheet.md
  • docs/cypher-rosetta.md
  • docs/gremlin-rosetta.md
  • docs/dynamic-query-examples.md
  • docs/optimization-checklist.md
  • examples/authoring-patterns.md
  • examples/search-patterns.md
  • examples/optimization-patterns.md

Notes

  • This repo uses the hosted skills.sh layout: skills/<name>/SKILL.md.
  • Local OpenCode discovery still uses .opencode/skills/, .claude/skills/, or .agents/skills/ after installation.
  • This repo is intentionally written against public Helix behavior and repo-local canonical examples rather than app-specific implementations.

About

Helix Skills

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors