Skip to content

data modeling - update readme #252

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
a-s-g93 merged 1 commit into from
Dec 16, 2025
Merged

data modeling - update readme #252

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions servers/mcp-neo4j-data-modeling/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
### Changed

### Added
* Update README to include new tools and optional `return_validated` argument to validation tools

## v0.8.0

Expand Down
27 changes: 24 additions & 3 deletions servers/mcp-neo4j-data-modeling/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,19 +90,22 @@ The server offers these core tools:
- Validate a single node structure
- Input:
- `node` (Node): The node to validate
- Returns: True if valid, raises ValueError if invalid
- `return_validated` (bool, optional): If True, returns the validated node object instead of True
- Returns: True if valid (or validated Node object if `return_validated=True`), raises ValueError if invalid

- `validate_relationship`
- Validate a single relationship structure
- Input:
- `relationship` (Relationship): The relationship to validate
- Returns: True if valid, raises ValueError if invalid
- `return_validated` (bool, optional): If True, returns the validated relationship object instead of True
- Returns: True if valid (or validated Relationship object if `return_validated=True`), raises ValueError if invalid

- `validate_data_model`
- Validate the entire data model structure
- Input:
- `data_model` (DataModel): The data model to validate
- Returns: True if valid, raises ValueError if invalid
- `return_validated` (bool, optional): If True, returns the validated data model object instead of True
- Returns: True if valid (or validated DataModel object if `return_validated=True`), raises ValueError if invalid

#### 👁️ Visualization Tools
- `get_mermaid_config_str`
Expand Down Expand Up @@ -141,6 +144,24 @@ These tools provide integration with **[Arrows](https://arrows.app/)** - a graph
- Returns: String representation of the data model in OWL Turtle format
- Note: **This conversion is lossy** - Relationship properties are not preserved since OWL does not support properties on ObjectProperties

- `export_to_pydantic_models`
- Export a data model to Pydantic models
- Input:
- `data_model` (DataModel): The data model to export
- Returns: String representation of the Pydantic models as a Python file, including imports and model definitions for nodes, relationships, and the complete data model

- `export_to_neo4j_graphrag_pkg_schema`
- Export a data model to Neo4j GraphRAG Python Package schema format
- Input:
- `data_model` (DataModel): The data model to export
- Returns: Dictionary containing the Neo4j GraphRAG Python Package schema

- `load_from_neo4j_graphrag_pkg_schema`
- Load a data model from Neo4j GraphRAG Python Package schema format
- Input:
- `neo4j_graphrag_python_package_schema` (dict): Neo4j GraphRAG Python Package schema dictionary
- Returns: DataModel object

#### 📚 Example Data Model Tools

These tools provide access to pre-built example data models for common use cases and domains.
Expand Down