mirror of
https://github.com/eliasstepanik/core.git
synced 2026-01-11 10:08:27 +00:00
Update README.md
This commit is contained in:
parent
bbf63b6b11
commit
e37e9d7858
57
README.md
57
README.md
@ -17,20 +17,35 @@ C.O.R.E is built for two reasons:
|
||||
|
||||
## How is C.O.R.E different from other Memory Providers?
|
||||
|
||||
C.O.R.E uses a **temporal knowledge graph**, not basic vector or key-value memory. This enables structured recall—capturing not just what was said, but who said it, when, and why it mattered.
|
||||
Unlike most memory systems—which act like basic sticky notes, only showing what’s true right now. C.O.R.E is built as a dynamic, living temporal knowledge graph:
|
||||
|
||||
You can ask, “_What changed in our pricing since Q1?_” and see precise updates, people involved, and the timeline. Or, “_What does Mike know about Project Phoenix?_” and get answers based on meetings or discussions she joined.
|
||||
- Every fact is a first-class “Statement” with full history, not just a static edge between entities.
|
||||
- Each statement includes what was said, who said it, when it happened, and why it matters.
|
||||
- You get full transparency: you can always trace the source, see what changed, and explore why the system “believes” something.
|
||||
|
||||
C.O.R.E supports **temporal reasoning**, **relational memory**, and **traceability** —ideal for AI assistants needing structured, historical, and inferential memory.
|
||||
### Use Case Example: Real Change Auditing
|
||||
|
||||
## Getting Started
|
||||
Imagine you ask SOL: "What changed in our pricing since Q1?"
|
||||
|
||||
### Prerequisites
|
||||
With C.O.R.E, you see exactly what prices changed, who approved them, the context (meeting, email, document), and when each update happened—enabling true compliance, auditability, and insight across products, teams, and time.
|
||||
|
||||
Or ask: “What does Mike know about Project Phoenix?” and get a timeline of meetings, decisions, and facts Mike was involved in, with full traceability to those specific events.
|
||||
|
||||
|
||||
## C.O.R.E Cloud Setup
|
||||
|
||||
1. Sign up to [Core Cloud](https://core.heysol.ai) and start building your memory graph.
|
||||
2. Add your text that you want to save in memory. Once clicking on add button your memory graph will be generated.
|
||||
3. [Connect Core Memory MCP with Cursor](#connecting-core-mcp-with-cursor)
|
||||
|
||||
## C.O.R.E Local Setup
|
||||
|
||||
#### Prerequisites
|
||||
|
||||
1. Docker
|
||||
2. OpenAI API Key
|
||||
|
||||
### Run C.O.R.E locally by
|
||||
#### Run C.O.R.E locally
|
||||
|
||||
1. **Copy Environment Variables**
|
||||
|
||||
@ -70,6 +85,36 @@ C.O.R.E supports **temporal reasoning**, **relational memory**, and **traceabili
|
||||
|
||||
- Use the dashboard's search feature to query your ingested data within your private space.
|
||||
|
||||
## Connecting CORE MCP with Cursor
|
||||
|
||||
1. Open the CORE dashboard and navigate to the API section to generate a new API token.
|
||||
2. In Cursor, go to: Settings → Tools & Integrations → New MCP Server.
|
||||
3. Add the CORE MCP server using the configuration format below. Be sure to replace the API_TOKEN value with the token you generated in step 1.
|
||||
|
||||
MCP configuration to add in Cursor
|
||||
|
||||
``` json
|
||||
{
|
||||
"mcpServers": {
|
||||
"memory": {
|
||||
"command": "npx",
|
||||
"args": ["-y", "@redplanethq/core-mcp"],
|
||||
"env": {
|
||||
"API_TOKEN": "YOUR_API_TOKEN_HERE",
|
||||
"API_BASE_URL": "https://core.heysol.ai",
|
||||
"SOURCE": "cursor"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
4. Go to Settings-> User rules -> New Rule -> and add the below rule to ensure all your chat interactions are being stored in CORE memory
|
||||
|
||||
```
|
||||
After every interaction, update the memory with the user's query and the assistant's
|
||||
response to core-memory mcp. sessionId should be the uuid of the conversation
|
||||
```
|
||||
|
||||
## Connecting to the API
|
||||
|
||||
You can also interact with C.O.R.E. programmatically via its APIs.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user