get_entity_context
Retrieve all information about an entity
Get comprehensive context about an entity including all observations and relations.
Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
entityName | string | REQUIRED | - | Name of entity to look up (1-200 chars) |
includeRelated | boolean | OPTIONAL | true | Include relations in response |
Example Request
Response
Compact Mode (Default)
When COMPACT_RESPONSES=true (default), responses use short keys to reduce token usage by 40-60%:
Key mapping: ok=found, n=name, t=type, o=observations, r=relations, rel=relation_type
Verbose Mode
When COMPACT_RESPONSES=false:
Entity Not Found
Compact Mode
Verbose Mode
Use Cases
Before Responding to User
Get all known preferences and context before crafting a response.
Project Overview
Retrieve all facts, technologies, and team relations for a project.
Quick Lookup (No Relations)
Get just the facts about an entity without relation queries.
Response Structure
| Field | Compact Key | Description |
|---|---|---|
entity | n, t | Basic entity info (name, type) |
observations | o | All stored facts about the entity |
relations.outgoing | r.out | Relations where this entity is the source |
relations.incoming | r.in | Relations where this entity is the target |
Errors
| Error | Cause | Fix |
|---|---|---|
| Entity not found | No entity exists with the provided name | Verify entity name or create entity first |
| Invalid entity name | Name exceeds 200 chars or is empty | Provide a valid name (1-200 chars) |
| Memory not enabled | ENABLE_MEMORY feature flag is false | Set ENABLE_MEMORY=true |
| Database error | Connection or query failure | Check DB connectivity and logs |