FunctionDefinitionReadonly.json

{
  "name": "execute_kip_readonly",
  "description": "Executes one or more read-only KIP (Knowledge Interaction Protocol) commands (e.g. FIND, SEARCH, DESCRIBE, EXPORT) against the Cognitive Nexus to query from your persistent memory.",
  "parameters": {
    "type": "object",
    "properties": {
      "command": {
        "type": "string",
        "description": "A single complete read-only KIP command (FIND / SEARCH / DESCRIBE / EXPORT). Mutually exclusive with commands."
      },
      "commands": {
        "type": "array",
        "description": "An array of read-only KIP commands (FIND / SEARCH / DESCRIBE / EXPORT) for batch execution (reduces round-trips). Commands are executed sequentially; per-command errors are returned inline without aborting the batch. KML commands (UPSERT / UPDATE / MERGE / DELETE) are rejected by this endpoint.",
        "items": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "object",
              "properties": {
                "command": {
                  "type": "string",
                  "description": "A complete read-only KIP command with parameters scoped to this command."
                },
                "parameters": {
                  "type": "object",
                  "description": "Optional parameters for this command. These override shared parameters with the same keys."
                }
              },
              "required": [
                "command"
              ],
              "additionalProperties": false
            }
          ]
        }
      },
      "parameters": {
        "type": "object",
        "description": "An optional JSON object of key-value pairs used for safe substitution of placeholders in the command string(s). Placeholders should start with ':' (e.g., :name, :limit). IMPORTANT: A placeholder must occupy a complete KIP value position (e.g., name: :name, LIMIT :limit, or SEARCH CONCEPT :term). Do not embed placeholders inside quoted strings (e.g., \"Hello :name\"), because substitution uses JSON serialization."
      },
      "dry_run": {
        "type": "boolean",
        "description": "If set to true, the command(s) will only be validated for syntactical and logical correctness without being executed."
      }
    },
    "oneOf": [
      {
        "required": [
          "command"
        ]
      },
      {
        "required": [
          "commands"
        ]
      }
    ],
    "additionalProperties": false
  }
}