modelcontextprotocol/servers
Watch
1
0
Fork
You've already forked servers
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

README improvements

Browse source
This commit is contained in:
Barry Zhang 2024-11-21 11:00:47 -05:00
commit 4cce597253
No known key found for this signature in database
1 changed files with 10 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

18
src/memory/README.md
View file

@ -1,5 +1,5 @@
# Knowledge Graph Memory Server # Knowledge Graph Memory Server
A basic MCP server implementation that provides persistent memory using a knowledge-graph. The server manages entities, their observations, and the relationships between them using a JSON-based file system. A basic MCP server implementation that provides persistent memory using a knowledge graph. The server manages entities, their observations, and the relationships between them using a JSON-based file system.
This lets Claude remember information about the user across chats and projects, and lets them bypass the issues of having super long chats This lets Claude remember information about the user across chats and projects, and lets them bypass the issues of having super long chats
@ -16,16 +16,17 @@ Example:
{ {
"name": "John_Smith", "name": "John_Smith",
"entityType": "person", "entityType": "person",
"observations": ["Lives in New York", "Works as a software engineer"] "observations": ["Speaks fluent Spanish"]
} }
``` ```
## Relations ## Relations
Relations define directed connections between entities. They are always stored in active voice and describe how entities interact or relate to each other. Relations define directed connections between entities. They are always stored in active voice and describe how entities interact or relate to each other.
Example: Example:
```jsonCopy{ ```json
{
"from": "John_Smith", "from": "John_Smith",
"to": "TechCorp", "to": "Anthropic",
"relationType": "works_at" "relationType": "works_at"
} }
``` ```
@ -38,7 +39,8 @@ Observations are discrete pieces of information about an entity. They are:
- Should be atomic (one fact per observation) - Should be atomic (one fact per observation)
Example: Example:
```jsonCopy{ ```json
{
"entityName": "John_Smith", "entityName": "John_Smith",
"observations": [ "observations": [
"Speaks fluent Spanish", "Speaks fluent Spanish",
@ -70,9 +72,9 @@ Example:
- search_nodes: Search for nodes based on names, types, and observation content - search_nodes: Search for nodes based on names, types, and observation content
- open_nodes: Access specific nodes by their names - open_nodes: Access specific nodes by their names
# Prompts # Prompt
The prompt for utilizing memory depends on the use case, but here is an example prompt for chat personalization. You could use this prompt in the "Custom Instructions" field of a Project The prompt for utilizing memory depends on the use case, but here is an example prompt for chat personalization. You could use this prompt in the "Custom Instructions" field of a Project. Changing this prompt will help the model determine the frequency and types of memories created.
``` ```
Follow these steps for each interaction: Follow these steps for each interaction:
@ -95,7 +97,7 @@ Follow these steps for each interaction:
4. Memory Update: 4. Memory Update:
- If any new information was gathered during the interaction, update your memory as follows: - If any new information was gathered during the interaction, update your memory as follows:
a) Create nodes for recurring organizations, people, and significant events, connecting them to the current node. a) Create entities for recurring organizations, people, and significant events, connecting them to the current node using relations
b) Store most facts as observations within these nodes b) Store most facts as observations within these nodes
- Try to perform all updates in one operation using the create and delete functions. - Try to perform all updates in one operation using the create and delete functions.
``` ```