MCP Graphiti

🚀 Graphiti Project Introduction

Graphiti is a knowledge graph construction tool based on Docker and GraphQL. It aims to extract information from various sources (such as documents, code comments, etc.) in a simple and easy - to - use way and build semantic networks. This project is designed for developers to help them quickly set up and manage knowledge graphs.

🚀 Quick Start

1. Clone the project and configure the environment

git clone https://github.com/rawr-ai/mcp-graphiti.git
cd mcp-graphiti
cp .env.example .env   # Copy the example environment file

⚠️ Important Note

• If NEO4J_PASSWORD is set to the default value 'password', the program will refuse to start unless GRAPHITI_ENV=dev or GRAPHITI_ENV=development is explicitly set.
• Ensure a strong password is configured for NEO4J_PASSWORD in non - development environments.

2. Install the CLI tool

pipx install . --include-deps   # Recommended installation method for users
# Or for contributors:
python -m venv .venv && source .venv/bin/activate && pip sync uv.lock && pip install -e .

3. Start the service

graphiti compose   # Generate the docker-compose.yml file
graphiti up -d     # Start the service in the background

4. Create a project

cd ~/code
graphiti init acme-support-bot   # Run this command in the root directory of the new project
cd acme-support-bot
# Add entity YAML files to the ai/graph/entities/ directory

✨ Features

Graphiti offers the following main features:

1. Knowledge graph construction: Extract information from multiple sources and automatically build semantic networks.
2. GraphQL query support: Query and retrieve knowledge graph data through the GraphQL interface.
3. Extensible plugin system: Support custom plugins for easy function expansion.
4. Visual interface: Provide an intuitive graphical interface for viewing and managing knowledge graphs.

📦 Installation

The installation steps are included in the "Quick Start" section above.

📚 Documentation

Project Configuration (mcp-projects.yaml)

The mcp-projects.yaml file is used to define and manage the configurations of multiple projects, including the following:

1. Project list: List all knowledge graphs to be built.
2. Data source configuration: Specify the sources of documents, code comments, etc. for each project.
3. Plugin extension: Define the usage of custom plugins.

Security Tips

• Ensure that all sensitive information (such as API keys and database credentials) is not stored in plain text in the code.
• Regularly back up knowledge graph data to prevent accidental loss.

Frequently Asked Questions

Q: How to extend functionality?

A: You can extend functionality by writing custom plugins and adding them to mcp-projects.yaml.

Q: How to optimize performance?

A: You can optimize performance in the following ways:

1. Configure an appropriate caching strategy.
2. Use an efficient storage backend (such as Redis).
3. Process data extraction tasks in parallel.

Danger Zone

• Experimental features: Some new features may not have been fully tested. Please carefully evaluate the risks before using them.
• Data cleaning: Ensure that important data has been backed up before performing data cleaning operations.

Future Development Plans

1. Enhance the plugin system: Provide more built - in plugins and support more flexible extension methods.
2. Optimize performance: Improve the efficiency of building and querying large - scale knowledge graphs.
3. Improve documentation: Provide more detailed usage guides and technical documentation to lower the learning curve.

For more information, please visit the project's official website or refer to the relevant technical documentation.