Skip to main content

MCP Tools

RushDB MCP exposes 37 tools. 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 project
WriteCreates or updates project data
DestructiveDeletes or replaces data; preview and confirm first

An asterisk marks a required input.

Discovery and Properties

ToolLevelMain inputsPurpose
getOntologyMarkdownReadlabels?, force?Return the complete graph ontology as compact Markdown. Call once at session start.
getOntologyReadlabels?, force?Return structured ontology 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*, options?, transactionId?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*, options?, transactionId?Insert or upsert multiple records with the same label.
bulkDeleteRecordsDestructivewhere*, labels?, transactionId?Delete all records matching a query. Preview with findRecords first.
exportRecordsReadlabels?, where?, limit?, orderBy?Export matching records as CSV.

Relationships

ToolLevelMain inputsPurpose
findRelationshipsReadwhere?, limit?, skip?, orderBy?Inspect edges and discover graph paths before traversal queries.
attachRelationWritesourceId*, targetId?, targetIds?, relationType?, direction?, transactionId?Create relationships between existing records.
detachRelationDestructivesourceId*, targetId?, targetIds?, relationType?, direction?, transactionId?Remove relationships between records.

Suggested Relationship Patterns

ToolLevelMain inputsPurpose
listRelationshipPatternsReadnoneList inferred patterns, ontology relationship summaries, and analysis status.
analyzeRelationshipPatternsWritenoneQueue ontology analysis. This may invoke the configured LLM.
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.

See Suggested Relationship Patterns for lifecycle details and REST and SDK examples.

ToolLevelMain inputsPurpose
findEmbeddingIndexesReadnoneList embedding index policies configured for the project.
createEmbeddingIndexWritelabel*, propertyName*, sourceType?, similarityFunction?, dimensions?Create a managed or external embedding index policy.
getEmbeddingIndexStatsReadindexId*Check indexing progress for an embedding index.
upsertEmbeddingVectorsWriteindexId*, items*Write pre-computed vectors to an external index.
deleteEmbeddingIndexDestructiveindexId*Delete an embedding index and its stored vectors.
semanticSearchReadpropertyName*, labels*, query?, queryVector?, sourceType?, similarityFunction?, where?, topK?, limit?, skip?Rank records by vector similarity, optionally after exact filtering.

Utilities

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

Query Rules

  • Never guess labels or property names. Start with getOntologyMarkdown.
  • 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.