API Reference

API Reference Overview

Complete reference for HyperMemory MCP tools

API Reference

HyperMemory exposes 8 MCP tools for memory operations. This reference documents each tool’s parameters, responses, and behavior.

Available tools

ToolDescriptionScope Required
memory_storeStore a new memory nodememory:write
memory_recallQuery memories by natural languagememory:read
memory_find_relatedFind nodes related to a given nodememory:read
memory_get_relationshipsGet edges and hyperedges for a nodememory:read
memory_updateUpdate an existing nodememory:write
memory_forgetDelete a nodememory:write
memory_export_subgraphExport a portion of the graphmemory:admin
memory_load_linkImport a subgraphmemory:admin

Usage costs

Operation TypeCost
Write operations (store, update, forget, load_link)Free
Read operations (recall, find_related, get_relationships, export)1 query

Request format

All tools are called via MCP JSON-RPC:

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "tool_name",
    "arguments": {
      "param1": "value1",
      "param2": "value2"
    }
  }
}

Response format

Successful responses:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "data": "..."
  }
}

Error responses:

{
  "jsonrpc": "2.0",
  "id": 1,
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable message",
    "details": {}
  }
}

Common error codes

CodeDescriptionResolution
INVALID_PARAMETERMissing or invalid parameterCheck parameter types and requirements
NODE_NOT_FOUNDReferenced node doesn’t existVerify node ID
UNAUTHORIZEDInvalid or missing API keyCheck Authorization header
FORBIDDENKey lacks required scopeUse key with appropriate scope
RATE_LIMITEDToo many requestsImplement backoff, try later
QUOTA_EXCEEDEDMonthly limit reachedUpgrade plan or wait for reset

Base URL

https://api.hypermemory.io/mcp

Authentication

All requests require Bearer token authentication:

Authorization: Bearer YOUR_API_KEY

Rate limits

PlanRequests/minute
Free60
Developer300
Pro1000
EnterpriseCustom

Pagination

Tools that return lists support pagination:

{
  "arguments": {
    "query": "...",
    "max_results": 10,
    "offset": 20
  }
}

Response includes pagination info:

{
  "results": [...],
  "total": 150,
  "offset": 20,
  "limit": 10,
  "has_more": true
}

Tool reference