Skip to content

Commit d11e34d

Browse files
authored
docs: update README with MCP server and REST service sections (#395)
Update README.md to improve structure and clarity. Removed redundant section on Graph Service and added a new section for REST Service. Included a tip about the MCP server for enhanced user guidance.
1 parent 967e560 commit d11e34d

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

README.md

+12-7
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ Graphiti
1010
<h2 align="center"> Build Real-Time Knowledge Graphs for AI Agents</h2>
1111
<div align="center">
1212

13-
1413
[![Lint](https://github.com/getzep/Graphiti/actions/workflows/lint.yml/badge.svg?style=flat)](https://github.com/getzep/Graphiti/actions/workflows/lint.yml)
1514
[![Unit Tests](https://github.com/getzep/Graphiti/actions/workflows/unit_tests.yml/badge.svg)](https://github.com/getzep/Graphiti/actions/workflows/unit_tests.yml)
1615
[![MyPy Check](https://github.com/getzep/Graphiti/actions/workflows/typecheck.yml/badge.svg)](https://github.com/getzep/Graphiti/actions/workflows/typecheck.yml)
@@ -23,10 +22,16 @@ Graphiti
2322
<div align="center">
2423

2524
<a href="https://trendshift.io/repositories/12986" target="_blank"><img src="https://trendshift.io/api/badge/repositories/12986" alt="getzep%2Fgraphiti | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
25+
2626
</div>
27+
2728
:star: _Help us reach more developers and grow the Graphiti community. Star this repo!_
29+
2830
<br />
2931

32+
> [!TIP]
33+
> Check out the new [MCP server for Graphiti](mcp_server/README.md)! Give Claude, Cursor, and other MCP clients powerful Knowledge Graph-based memory.
34+
3035
Graphiti is a framework for building and querying temporally-aware knowledge graphs, specifically tailored for AI agents operating in dynamic environments. Unlike traditional retrieval-augmented generation (RAG) methods, Graphiti continuously integrates user interactions, structured and unstructured enterprise data, and external information into a coherent, queryable graph. The framework supports incremental data updates, efficient retrieval, and precise historical queries without requiring complete graph recomputation, making it suitable for developing interactive, context-aware AI applications.
3136

3237
Use Graphiti to:
@@ -159,12 +164,6 @@ For a complete working example, see the [Quickstart Example](./examples/quicksta
159164

160165
The example is fully documented with clear explanations of each functionality and includes a comprehensive README with setup instructions and next steps.
161166

162-
## Graph Service
163-
164-
The `server` directory contains an API service for interacting with the Graphiti API. It is built using FastAPI.
165-
166-
Please see the [server README](./server/README.md) for more information.
167-
168167
## MCP Server
169168

170169
The `mcp_server` directory contains a Model Context Protocol (MCP) server implementation for Graphiti. This server allows AI assistants to interact with Graphiti's knowledge graph capabilities through the MCP protocol.
@@ -181,6 +180,12 @@ The MCP server can be deployed using Docker with Neo4j, making it easy to integr
181180

182181
For detailed setup instructions and usage examples, see the [MCP server README](./mcp_server/README.md).
183182

183+
## REST Service
184+
185+
The `server` directory contains an API service for interacting with the Graphiti API. It is built using FastAPI.
186+
187+
Please see the [server README](./server/README.md) for more information.
188+
184189
## Optional Environment Variables
185190

186191
In addition to the Neo4j and OpenAi-compatible credentials, Graphiti also has a few optional environment variables.

0 commit comments

Comments
 (0)