Skip to content

Commit 854a31c

Browse files
authored
Merge pull request #66 from neo4j-contrib/prep-data-modeling-v0.1.1-release
Update README.md
2 parents ff3dcd2 + c0d8b6e commit 854a31c

File tree

1 file changed

+34
-8
lines changed

1 file changed

+34
-8
lines changed

servers/mcp-neo4j-data-modeling/README.md

Lines changed: 34 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,6 @@ A Model Context Protocol (MCP) server implementation that provides tools for cre
1010

1111
The server provides these resources:
1212

13-
- `resource://init`
14-
- Create an empty data model to start with
15-
- Returns: Empty DataModel with no nodes or relationships
16-
1713
- `resource://schema/node`
1814
- Get the JSON schema for a Node object
1915
- Returns: JSON schema defining the structure of a Node
@@ -29,6 +25,11 @@ The server provides these resources:
2925
- `resource://schema/data_model`
3026
- Get the JSON schema for a DataModel object
3127
- Returns: JSON schema defining the structure of a DataModel
28+
29+
- `resource://neo4j_data_ingest_process`
30+
- Get a detailed explanation of the recommended process for ingesting data into Neo4j using the data model
31+
- Returns: Markdown document explaining the ingest process
32+
3233

3334
### 🛠️ Tools
3435

@@ -54,11 +55,11 @@ The server offers these core tools:
5455
- Returns: True if valid, raises ValueError if invalid
5556

5657
#### 👁️ Visualization Tools
57-
- `visualize_data_model`
58-
- Generate and open an interactive visualization of the data model in your browser
58+
- `get_mermaid_config_str`
59+
- Generate a Mermaid diagram configuration string for the data model, suitable for visualization in tools that support Mermaid
5960
- Input:
6061
- `data_model` (DataModel): The data model to visualize
61-
- Returns: None (opens browser visualization)
62+
- Returns: Mermaid configuration string representing the data model
6263

6364
#### 🔄 Import/Export Tools
6465

@@ -76,6 +77,31 @@ These tools provide integration with **[Arrows](https://arrows.app/)** - a graph
7677
- `data_model` (DataModel): The data model to export
7778
- Returns: JSON string compatible with Arrows app
7879

80+
#### 📝 Cypher Ingest Tools
81+
82+
These tools may be used to create Cypher ingest queries based on the data model. These queries may then be used by other MCP servers or applications to load data into Neo4j.
83+
84+
- `get_constraints_cypher_queries`
85+
- Generate Cypher queries to create constraints (e.g., unique keys) for all nodes in the data model
86+
- Input:
87+
- `data_model` (DataModel): The data model to generate constraints for
88+
- Returns: List of Cypher statements for constraints
89+
90+
- `get_node_cypher_ingest_query`
91+
- Generate a Cypher query to ingest a list of node records into Neo4j
92+
- Input:
93+
- `node` (Node): The node definition (label, key property, properties)
94+
- Returns: Parameterized Cypher query for bulk node ingestion (using `$records`)
95+
96+
- `get_relationship_cypher_ingest_query`
97+
- Generate a Cypher query to ingest a list of relationship records into Neo4j
98+
- Input:
99+
- `data_model` (DataModel): The data model containing nodes and relationships
100+
- `relationship_type` (str): The type of the relationship
101+
- `relationship_start_node_label` (str): The label of the start node
102+
- `relationship_end_node_label` (str): The label of the end node
103+
- Returns: Parameterized Cypher query for bulk relationship ingestion (using `$records`)
104+
79105
## 🔧 Usage with Claude Desktop
80106

81107
### 💾 Released Package
@@ -88,7 +114,7 @@ Add the server to your `claude_desktop_config.json` with the transport method sp
88114
"mcpServers": {
89115
"neo4j-data-modeling": {
90116
"command": "uvx",
91-
"args": [ "mcp-neo4j-data-modeling@0.1.0", "--transport", "stdio" ]
117+
"args": [ "mcp-neo4j-data-modeling@0.1.1", "--transport", "stdio" ]
92118
}
93119
}
94120
```

0 commit comments

Comments
 (0)