A guide to get you started with HelixDB MCP Endpoints
connection_id
, so each call extends the same traversal. This allows agents to
chain and build complex traversal and filter queries over time while being able to view intermediate results. Stream results with mcp/next
or batch with mcp/collect
.
You can also dynamically pass lists created at runtime, toggle AND/OR property groups, and filter by temporary traversals. Run multiple traversals in concurrently and asynchronously using multiple connection IDs by initializing each traversal with its own connection_id
to keep them separate and easy to manage.
init
"mcp/init"
{}
).
Response Format
next
"mcp/next"
collect
"mcp/collect"
range
(optional) : range of results to collect (default: {"start": 0, "end": -1}
)drop
(optional) : resets the traversal after collecting results (default: true
)reset
"mcp/reset"
schema_resource
"mcp/schema_resource"
n_from_type
"mcp/n_from_type"
node_type
: the label of node to retrievee_from_type
"mcp/e_from_type"
edge_type
: the label of edge to retrieveout_step
"mcp/out_step"
edge_type
: the target entity (node
or vec
)edge_label
: the label of edge to traverse outout_e_step
"mcp/out_e_step"
edge_label
: the label of edge to traverse outin_step
"mcp/in_step"
edge_type
: the source entity (node
or vec
)edge_label
: the label of edge to traverse intoin_e_step
"mcp/in_e_step"
edge_label
: the label of edge to traverse intofilter_items
"mcp/filter_items"
filters
is a list of filters to apply to the current state of the traversal.
The format of the filters is as follows:
OR
operation and the inner list is the AND
operation.
key
: the name of the property to filter onoperator
: the operator to use for the filtervalue
: the value to filter onOperator | Description | Operator | Description |
---|---|---|---|
== | equals | != | not equals |
> | greater than | >= | greater than or equal to |
< | less than | <= | less than or equal to |
contains
and not_contains
operators by using the ==
and !=
operator with a list of values.AND
operation.
search_vector
"mcp/search_vector"
k
results with a minimum score of min_score
.
Additionally, you can continue the traversal from the search results by using the traversal tools.
Request Format
vector
: the vector to search fork
: the number of results to returnmin_score
(optional) : the minimum score to return (default: 0.0
)search_vector_text
"mcp/search_vector_text"
label
.
Request Format
query
: the text to search forlabel
: the label of the vectors to search forsearch_keyword
"mcp/search_keyword"
query
: the text to search forlabel
: the label of the nodes, edges, or vectors to search forlimit
: the number of results to returncreated_at
property from January to March or June to September.
[0.1, 0.2, 0.3, 0.4, 0.5]
with a minimum score of 0.7.