Utilities
Utilities & Statistics¶
Tools for monitoring, tracking, and managing your memory system.
get_stats¶
Description: Get statistics about your collections and memories.
Parameters: None
Example:
curl -X POST https://akashic-mcp.com/mcp \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_MCP_TOKEN" \
-d '{"jsonrpc":"2.0","method":"tools/call","params":{"name":"system","arguments":{"action":"get_stats"}},"id":1}'
Response:
Use Cases: - Monitoring memory usage - Checking collection count - System health monitoring
get_memory_usage¶
Description: Get memory usage metrics including first/last activity and recent activity counts.
Parameters: None
Example:
curl -X POST https://akashic-mcp.com/mcp \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_MCP_TOKEN" \
-d '{"jsonrpc":"2.0","method":"tools/call","params":{"name":"system","arguments":{"action":"get_memory_usage"}},"id":1}'
Response:
{
"first_memory_at": "2024-01-01T00:00:00Z",
"last_activity_at": "2024-01-15T14:30:00Z",
"memories_last_7_days": 15,
"memories_last_30_days": 45,
"collections_scanned": 5
}
Use Cases: - Tracking memory activity over time - Monitoring recent usage patterns - Understanding memory growth
track_system_change¶
Description: Record a system change and update a sequential Mermaid diagram for the target system.
Parameters:
- project_name (required): Project name context
- environment (optional): Client environment (e.g., "cursor", "chatgpt"). Defaults to "Default" if not provided.
- system (optional): Target system name/path (default: "main")
- change_type (required): Type of change - "code_change", "config_change", "architectural_decision", "dependency_change", "deployment_change"
- description (required): Short description of the change
- files_changed (optional): List of files changed
- collection_name (optional): Collection to store change memories (default: "system_changes")
Example:
curl -X POST https://akashic-mcp.com/mcp \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_MCP_TOKEN" \
-d '{"jsonrpc":"2.0","method":"tools/call","params":{"name":"system","arguments":{"action":"track_change","project_name":"my-api","environment":"cursor","system":"api.auth","change_type":"code_change","description":"Added JWT refresh token support","files_changed":["src/auth/jwt.ts","src/auth/refresh.ts"]}},"id":1}'
Response:
{
"result": "Change recorded and Mermaid diagram updated",
"change_memory_id": "mem-change-001",
"state_memory_id": "mem-state-001",
"diagram_file_id": "file-diagram-001"
}
Use Cases: - Tracking system changes over time - Maintaining visual system diagrams - Documenting architectural evolution
Important Notes: - Creates system-change memory and system-state memory - Uploads updated Mermaid diagram as linked file - Use after implementing changes to keep history up to date
check_memory_compliance¶
Description: Check if the mandatory memory workflow was followed correctly.
Parameters:
- project_name (optional): Project name for context
- environment (optional): Environment name for context
Example:
curl -X POST https://akashic-mcp.com/mcp \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_MCP_TOKEN" \
-d '{"jsonrpc":"2.0","method":"tools/call","params":{"name":"system","arguments":{"action":"check_compliance","project_name":"my-api","environment":"cursor"}},"id":1}'
Response:
{
"compliant": true,
"warnings": [],
"hasSearchedMemory": true,
"hasUpdatedMemory": true,
"hasActiveConversationMemory": true,
"conversationMemoryId": "mem-conv-001",
"lastSearchTime": "2024-01-15T14:30:00Z",
"lastUpdateTime": "2024-01-15T14:35:00Z",
"recommendations": [
"Workflow followed correctly. Continue maintaining this pattern for all interactions."
]
}
Use Cases: - Self-verification after completing tasks - Debugging memory workflow issues - Ensuring proper memory management
Important Notes: - Verifies search_memory was called at start - Verifies update_memory/store_memory was called at end - Returns warnings if workflow not followed correctly
purge_owner_memory¶
Description: Permanently delete a collection and all its memories. This is a destructive operation with a safety flow.
Parameters:
- collection_name (required): Name of the collection to delete
- confirm_delete (optional): Must be exactly "CONFIRM_DELETE" to execute
Example (Preview):
curl -X POST https://akashic-mcp.com/mcp \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_MCP_TOKEN" \
-d '{"jsonrpc":"2.0","method":"tools/call","params":{"name":"system","arguments":{"action":"purge_owner","collection_name":"test-collection"}},"id":1}'
Response (Preview):
PREVIEW: Collection deletion:
Collection to delete: test-collection
Total memories in collection: 15
⚠️ CONSEQUENCES:
- Collection "test-collection" will be COMPLETELY DELETED
- ALL 15 memories in this collection will be permanently deleted
- This action CANNOT be undone
To execute this deletion, call the tool again with confirm_delete: "CONFIRM_DELETE"
Example (Execute):
curl -X POST https://akashic-mcp.com/mcp \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_MCP_TOKEN" \
-d '{"jsonrpc":"2.0","method":"tools/call","params":{"name":"system","arguments":{"action":"purge_owner","collection_name":"test-collection","confirm_delete":"CONFIRM_DELETE"}},"id":1}'
Response (Execute):
Use Cases: - Removing test collections - Cleaning up temporary data - Deleting outdated collections
Important Notes: - Safety flow: First call shows preview, second call with "CONFIRM_DELETE" executes - This operation cannot be undone - Deletes the specified collection for the authenticated user - Use with extreme caution
Related Documentation¶
- MCP Tools Reference - Complete tools reference
- Memory Management Guide - Learn how to organize and use memories effectively
- Getting Started - Quick start guide