Skip to main content

MCP Tools

RushDB MCP exposes 43 tools on RushDB Cloud; in direct mode against a self-hosted engine, the 6 Cloud-only tools are not listed. Names below use the exact lower camel case identifiers published in the MCP manifest.

The connected MCP client receives the full JSON schema for each tool. This page is the quick reference for choosing the correct tool and understanding its main inputs.

Safety Levels​

LevelMeaning
ReadRetrieves or computes data without changing the data
WriteCreates or updates project data
DestructiveDeletes or replaces data; preview and confirm first

An asterisk marks a required input.

Discovery and Properties​

ToolLevelMain inputsPurpose
getSchemaMarkdownReadlabels?, force?Return the complete graph schema as compact Markdown. Call once at session start.
getSchemaReadlabels?, force?Return structured schema JSON, including property IDs and vector indexes.
findLabelsReadwhere?, limit?, skip?, orderBy?List or filter record labels and counts.
findPropertiesReadwhere?, limit?, skip?, orderBy?Discover property names, types, IDs, and record counts.
findPropertyByIdReadpropertyId*Fetch metadata for one property.
propertyValuesReadpropertyId*, query?, orderBy?, limit?, skip?Return numeric or date ranges, or distinct string and boolean values.
deletePropertyDestructivepropertyId*Permanently remove a property and its values from all records.
getSearchQuerySpecReadnoneReturn the complete SearchQuery syntax reference.
getQueryBuilderPromptReadnoneReturn the built-in discovery-first query builder prompt.

Records​

ToolLevelMain inputsPurpose
findRecordsReadlabels?, where?, limit?, skip?, orderBy?, select?, groupBy?Search records and run grouped metrics queries.
findOneRecordReadlabels?, where?Return the first matching record for entity resolution probes.
findUniqRecordReadlabels?, where?Return exactly one matching record; fail when zero or multiple records match.
getRecordReadrecordId*Fetch one record by ID.
getRecordsByIdsReadrecordIds*Fetch multiple records by ID.
createRecordWritelabel*, data*, transactionId?, options?Insert or upsert one record.
updateRecordWriterecordId*, label*, data*, transactionId?Partially update one record while preserving unspecified fields.
setRecordDestructiverecordId*, label*, data*, transactionId?Replace all fields on one record.
deleteRecordDestructiverecordId*, transactionId?Delete one record by ID after previewing it with findRecords.
deleteRecordByIdDestructiverecordId*, transactionId?Delete one record by ID after previewing it with getRecord.
bulkCreateRecordsWritelabel*, data*, transactionId?, options?Insert or upsert multiple records with the same label.
bulkDeleteRecordsDestructivelabels?, where*, transactionId?Delete all records matching a query. Preview with findRecords first.
exportRecordsReadlabels?, where?, limit?, orderBy?Export matching records as CSV.

Relationships​

ToolLevelMain inputsPurpose
findRelationshipsReadwhere?, source?, target?, limit?, skip?, orderBy?Inspect edges. where filters edge type/properties; source/target filter endpoint records.
attachRelationWritesourceId*, targetId?, targetIds?, relationType?, direction?, properties?, transactionId?Create relationships between existing records.
detachRelationDestructivesourceId*, targetId?, targetIds?, relationType?, direction?Remove relationships between records: every type unless relationType is given, both ways unless direction is.
ToolLevelMain inputsPurpose
findEmbeddingIndexesReadnoneList embedding indexes with their names and status.
createEmbeddingIndexWritename?, label*, propertyName*, sourceType?, similarityFunction?, dimensions?Create an embedding index. On a self-hosted engine, create an external one (sourceType: "external", dimensions).
getEmbeddingIndexStatsReadindexId*Check how many records an index covers and has vectors for.
upsertEmbeddingVectorsWriteindexId*, items*Write pre-computed vectors to an external index.
deleteEmbeddingIndexDestructiveindexId*Delete an embedding index and its stored vectors.
vectorSearchReadindex?, propertyName?, query?, queryVector?, labels?, sourceType?, similarityFunction?, dimensions?, where?, mode?, ef?, scoreThreshold?, weight?, prefetchLimit?, fusion?, rrfK?, text?, limit?, skip?Rank records by vector similarity after exact filtering; add text for a hybrid search. On a self-hosted engine, pass queryVector.
semanticSearchReadpropertyName*, query?, queryVector?, labels*, sourceType?, similarityFunction?, dimensions?, where?, mode?, ef?, scoreThreshold?, limit?, skip?Deprecated alias for vectorSearch.
listTextIndexesReadnoneList text indexes with their status and pending changes.
createTextIndexWritelabel*, property*, name?, consistency?Declare a BM25 text index over one property, or * for every string.
deleteTextIndexDestructivename*Drop a text index by name.
textSearchReadquery*, index?, property?, labels?, where?, allTerms?, phrase?, limit?, skip?Keyword (BM25) search over a text index, after exact filtering.

RushDB Cloud: Smart Search and Relationship Patterns​

These tools need RushDB Cloud. In direct mode against a self-hosted engine they are not listed, and a call is refused.

ToolLevelMain inputsPurpose
smartSearchReadprompt*, currentQuery?Turn a natural-language request into a SearchQuery and run it.
listRelationshipPatternsReadnoneList inferred patterns, schema relationship summaries, and analysis status.
analyzeRelationshipPatternsWritenoneQueue schema analysis with RushDB Cloud's language model.
approveRelationshipPatternWriteid*Approve and apply a suggested pattern.
ignoreRelationshipPatternWriteid*Ignore a suggested pattern without applying it.
deleteRelationshipPatternDestructiveid*, deleteExisting?Delete a stored pattern and optionally its materialized relationships.

Utilities​

ToolLevelMain inputsPurpose
helpAddToClientReadnoneReturn instructions for adding RushDB MCP to a client.

Query Rules​

  • Never guess labels or property names. Start with getSchemaMarkdown.
  • Call getSearchQuerySpec before complex findRecords queries.
  • Do not pass limit with select; it restricts the record scan and produces incorrect metrics.
  • For a simple count, read total from findRecords.
  • Preview and explicitly confirm destructive operations.