@arkimedehq/recordare-client 0.1.0 → 0.2.0

package/src/tools.ts

@@ -0,0 +1,287 @@
+// SPDX-License-Identifier: AGPL-3.0-or-later
+// Copyright © 2026 Andrea Genovese
+
+/**
+ * The MCP tools Recordare serves (name, title, description, JSON Schema of the arguments), for connectors that must
+ * declare tools before talking to the service. Generated by the conformance suite (service/test/conformance,
+ * RECORDARE_UPDATE_TOOLS=1), which fails when this copy drifts from the service.
+ */
+export const TOOLS = [
+  {
+    "name": "correct_episode",
+    "title": "Correct a memory",
+    "description": "Correct a remembered episode (wrong date or detail). The old version is kept as history, never shown as current.",
+    "inputSchema": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "format": "uuid",
+          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
+        },
+        "content": {
+          "type": "string"
+        },
+        "occurred_at": {
+          "type": "string",
+          "pattern": "^\\d{4}-\\d{2}(-\\d{2})?$"
+        },
+        "date_precision": {
+          "type": "string",
+          "enum": [
+            "day",
+            "month",
+            "year",
+            "approximate"
+          ]
+        }
+      },
+      "required": [
+        "id"
+      ],
+      "$schema": "http://json-schema.org/draft-07/schema#"
+    }
+  },
+  {
+    "name": "forget_episode",
+    "title": "Forget a memory",
+    "description": "Forget an episode, when asked to. It is deleted with its corrections and never recreated.",
+    "inputSchema": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "format": "uuid",
+          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
+        }
+      },
+      "required": [
+        "id"
+      ],
+      "$schema": "http://json-schema.org/draft-07/schema#"
+    }
+  },
+  {
+    "name": "learn_source",
+    "title": "Learn a text",
+    "description": "Learn a text as knowledge (a manual, a page, a note — as plain text; send it again with the same title to replace it). It stays searchable with search_knowledge; the learning becomes a memory of this conversation.",
+    "inputSchema": {
+      "type": "object",
+      "properties": {
+        "title": {
+          "type": "string"
+        },
+        "text": {
+          "type": "string"
+        },
+        "author": {
+          "type": "string"
+        },
+        "kind": {
+          "type": "string",
+          "enum": [
+            "document",
+            "page",
+            "note",
+            "book",
+            "own_text"
+          ]
+        },
+        "uri": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "title",
+        "text"
+      ],
+      "$schema": "http://json-schema.org/draft-07/schema#"
+    }
+  },
+  {
+    "name": "log_episode",
+    "title": "Note something that happened or is planned",
+    "description": "Explicit capture (\"note that today I serviced the car\"). Resolve the date yourself (ISO).",
+    "inputSchema": {
+      "type": "object",
+      "properties": {
+        "content": {
+          "type": "string"
+        },
+        "kind": {
+          "type": "string",
+          "enum": [
+            "event",
+            "plan"
+          ]
+        },
+        "occurred_at": {
+          "type": "string",
+          "pattern": "^\\d{4}-\\d{2}(-\\d{2})?$"
+        },
+        "occurred_until": {
+          "type": "string",
+          "pattern": "^\\d{4}-\\d{2}(-\\d{2})?$"
+        },
+        "date_precision": {
+          "type": "string",
+          "enum": [
+            "day",
+            "month",
+            "year",
+            "approximate"
+          ]
+        },
+        "people": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "place": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "content"
+      ],
+      "$schema": "http://json-schema.org/draft-07/schema#"
+    }
+  },
+  {
+    "name": "remember",
+    "title": "Remember something",
+    "description": "Explicit \"remember that…\" about preferences, habits, values, knowledge.",
+    "inputSchema": {
+      "type": "object",
+      "properties": {
+        "content": {
+          "type": "string"
+        },
+        "category": {
+          "type": "string",
+          "enum": [
+            "preference",
+            "habit",
+            "value",
+            "relationship",
+            "knowledge",
+            "profile",
+            "constraint"
+          ]
+        }
+      },
+      "required": [
+        "content"
+      ],
+      "$schema": "http://json-schema.org/draft-07/schema#"
+    }
+  },
+  {
+    "name": "resolve_period",
+    "title": "Turn a period expression into dates",
+    "description": "Deterministic: \"questa settimana\", \"la settimana scorsa\", \"a febbraio\", \"lo scorso dicembre\", \"last week\"… → {from, to} (ISO, inclusive).",
+    "inputSchema": {
+      "type": "object",
+      "properties": {
+        "expression": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "expression"
+      ],
+      "$schema": "http://json-schema.org/draft-07/schema#"
+    }
+  },
+  {
+    "name": "search_episodes",
+    "title": "Search what happened",
+    "description": "Search your memory of what happened: what you lived, did, planned or learned, and what happened to the people you know (events, plans, changes), with dates and status. Each item has a subject: you (written in the first person), a person by name, someone, or undecided. Use `from`/`to` (ISO dates, inclusive; see resolve_period) for questions about a period. mode: \"search\" = most relevant, \"list\" = chronological in the period (overviews, counting), \"latest\" = most recent first (\"when did I last…\").",
+    "inputSchema": {
+      "type": "object",
+      "properties": {
+        "query": {
+          "description": "What to look for — pass the question also when listing a period: it ranks the items and finds the matching chat excerpts",
+          "type": "string"
+        },
+        "from": {
+          "description": "Start date, ISO (YYYY-MM-DD or YYYY-MM)",
+          "type": "string",
+          "pattern": "^\\d{4}-\\d{2}(-\\d{2})?$"
+        },
+        "to": {
+          "description": "End date, ISO (YYYY-MM-DD or YYYY-MM), inclusive",
+          "type": "string",
+          "pattern": "^\\d{4}-\\d{2}(-\\d{2})?$"
+        },
+        "mode": {
+          "type": "string",
+          "enum": [
+            "search",
+            "list",
+            "latest"
+          ]
+        },
+        "include_plans": {
+          "type": "boolean"
+        },
+        "limit": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 50
+        }
+      },
+      "$schema": "http://json-schema.org/draft-07/schema#"
+    }
+  },
+  {
+    "name": "search_knowledge",
+    "title": "Search what you learned",
+    "description": "Search the sources you learned (manuals, documents, pages, notes you were given or wrote): passages of their text, each with its source (title, author, who gave it, when) and the episodes that refer to it. For what happened, use search_episodes.",
+    "inputSchema": {
+      "type": "object",
+      "properties": {
+        "query": {
+          "type": "string",
+          "description": "What to look up"
+        },
+        "limit": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 20
+        }
+      },
+      "required": [
+        "query"
+      ],
+      "$schema": "http://json-schema.org/draft-07/schema#"
+    }
+  },
+  {
+    "name": "search_memory",
+    "title": "Search what you know about yourself and others",
+    "description": "Search your memory of preferences, habits, values, relationships, knowledge and current state (car, home, job…) — yours and of the people you know; each item has its subject. Use `as_of` (ISO date) for \"what was it on that date\" questions; each fact comes with its history.",
+    "inputSchema": {
+      "type": "object",
+      "properties": {
+        "query": {
+          "type": "string",
+          "description": "Topic"
+        },
+        "as_of": {
+          "description": "ISO date (YYYY-MM-DD); default today",
+          "type": "string",
+          "pattern": "^\\d{4}-\\d{2}(-\\d{2})?$"
+        },
+        "include_pending": {
+          "type": "boolean"
+        }
+      },
+      "required": [
+        "query"
+      ],
+      "$schema": "http://json-schema.org/draft-07/schema#"
+    }
+  }
+] as const;