Uoink 3.12.0 / tool reference

submit_library_result

Store a client's shelf-assignment result for one currently leased Librarian item.

Inputs

work_idRequired: text
client_idRequired: text
attempt_tokenRequired: text
submission_keyRequired: text
schema_versionRequired: see full schema
video_idRequired: text
source_revisionRequired: text
taxonomy_revisionRequired: text
packet_hashRequired: text
resultRequired: see full schema
usageRequired: see full schema

Full input schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$defs": {
    "id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "client": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "key": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "hash": {
      "type": "string",
      "pattern": "^[a-f0-9]{64}$"
    },
    "token": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{43,128}$"
    },
    "revision": {
      "type": "integer",
      "minimum": 0,
      "maximum": 2147483647
    },
    "confidence": {
      "type": "number",
      "minimum": 0,
      "maximum": 1
    },
    "evidence": {
      "type": "object",
      "properties": {
        "basis": {
          "type": "string",
          "enum": [
            "packet",
            "fetched_full"
          ]
        },
        "kind": {
          "type": "string",
          "enum": [
            "timed_clip",
            "text_only"
          ]
        },
        "excerpt_id": {
          "$ref": "#/$defs/hash"
        },
        "card_hash": {
          "$ref": "#/$defs/hash"
        },
        "quote": {
          "type": "string",
          "minLength": 1,
          "maxLength": 1000
        }
      },
      "required": [
        "basis",
        "kind",
        "excerpt_id",
        "card_hash",
        "quote"
      ],
      "additionalProperties": false
    },
    "membership": {
      "type": "object",
      "properties": {
        "shelf_id": {
          "$ref": "#/$defs/id"
        },
        "shelf_path": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 100
          },
          "minItems": 1,
          "maxItems": 3
        },
        "confidence": {
          "$ref": "#/$defs/confidence"
        },
        "evidence": {
          "$ref": "#/$defs/evidence"
        }
      },
      "required": [
        "shelf_id",
        "shelf_path",
        "confidence",
        "evidence"
      ],
      "additionalProperties": false
    },
    "result": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "outcome": {
              "const": "assigned"
            },
            "memberships": {
              "type": "array",
              "items": {
                "$ref": "#/$defs/membership"
              },
              "minItems": 1,
              "maxItems": 3
            }
          },
          "required": [
            "outcome",
            "memberships"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "outcome": {
              "type": "string",
              "enum": [
                "unmapped",
                "unsupported",
                "error"
              ]
            },
            "reason": {
              "type": "string",
              "minLength": 1,
              "maxLength": 500
            }
          },
          "required": [
            "outcome",
            "reason"
          ],
          "additionalProperties": false
        }
      ]
    },
    "usage": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "status": {
              "const": "reported"
            },
            "model": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200
            },
            "input_tokens": {
              "type": "integer",
              "minimum": 0,
              "maximum": 2147483647
            },
            "output_tokens": {
              "type": "integer",
              "minimum": 0,
              "maximum": 2147483647
            },
            "cache_read_tokens": {
              "type": "integer",
              "minimum": 0,
              "maximum": 2147483647
            },
            "cache_create_tokens": {
              "type": "integer",
              "minimum": 0,
              "maximum": 2147483647
            },
            "wall_time_ms": {
              "type": "integer",
              "minimum": 0,
              "maximum": 2147483647
            }
          },
          "required": [
            "status",
            "model",
            "input_tokens",
            "output_tokens",
            "wall_time_ms"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "status": {
              "const": "unavailable"
            },
            "model": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200
            },
            "reason": {
              "type": "string",
              "minLength": 1,
              "maxLength": 500
            },
            "wall_time_ms": {
              "type": "integer",
              "minimum": 0,
              "maximum": 2147483647
            }
          },
          "required": [
            "status",
            "reason"
          ],
          "additionalProperties": false
        }
      ]
    }
  },
  "type": "object",
  "properties": {
    "work_id": {
      "$ref": "#/$defs/id"
    },
    "client_id": {
      "$ref": "#/$defs/client"
    },
    "attempt_token": {
      "$ref": "#/$defs/token"
    },
    "submission_key": {
      "$ref": "#/$defs/key"
    },
    "schema_version": {
      "const": 1
    },
    "video_id": {
      "$ref": "#/$defs/id"
    },
    "source_revision": {
      "$ref": "#/$defs/hash"
    },
    "taxonomy_revision": {
      "$ref": "#/$defs/hash"
    },
    "packet_hash": {
      "$ref": "#/$defs/hash"
    },
    "result": {
      "$ref": "#/$defs/result"
    },
    "usage": {
      "$ref": "#/$defs/usage"
    }
  },
  "required": [
    "work_id",
    "client_id",
    "attempt_token",
    "submission_key",
    "schema_version",
    "video_id",
    "source_revision",
    "taxonomy_revision",
    "packet_hash",
    "result",
    "usage"
  ],
  "additionalProperties": false
}

Outputs and behavior

Store a client's shelf-assignment result for one currently leased Librarian item. Use after claim_library_work; use apply_reshelving to preview accepted assignments as label changes. Copy the packet's identifiers and revision hashes unchanged, and quote its evidence. Submission stages results without changing current labels; an identical submission_key retry replays the recorded response. Report unavailable usage honestly instead of inventing zero usage.

The registry does not publish an output schema for this tool. The description above is its documented behavior; response fields beyond it are not specified here.

Example call

Example tool name and arguments, generated from the input schema. Replace placeholder strings and sample numbers with your own values. This is a request template, not a recorded call or response.

{
  "name": "submit_library_result",
  "arguments": {
    "work_id": "YOUR_WORK_ID",
    "client_id": "YOUR_CLIENT_ID",
    "attempt_token": "REPLACE_WITH_REAL_TOKEN____________________",
    "submission_key": "YOUR_SUBMISSION_KEY",
    "schema_version": 1,
    "video_id": "YOUR_VIDEO_ID",
    "source_revision": "0000000000000000000000000000000000000000000000000000000000000000",
    "taxonomy_revision": "0000000000000000000000000000000000000000000000000000000000000000",
    "packet_hash": "0000000000000000000000000000000000000000000000000000000000000000",
    "result": {
      "outcome": "assigned",
      "memberships": [
        {
          "shelf_id": "YOUR_SHELF_ID",
          "shelf_path": [
            "YOUR_SHELF_PATH"
          ],
          "confidence": 0,
          "evidence": {
            "basis": "packet",
            "kind": "timed_clip",
            "excerpt_id": "0000000000000000000000000000000000000000000000000000000000000000",
            "card_hash": "0000000000000000000000000000000000000000000000000000000000000000",
            "quote": "YOUR_QUOTE"
          }
        }
      ]
    },
    "usage": {
      "status": "reported",
      "model": "YOUR_MODEL",
      "input_tokens": 0,
      "output_tokens": 0,
      "wall_time_ms": 0
    }
  }
}

Clients

This tool is available to MCP clients using stdio or http.

The registry records transport support, not individual client test results. See the MCP setup reference for named clients, configuration, and tool-list limits.

Set up your client All MCP tools

Source

Uoink 3.12.0 tool registry. Synced 2026-10-30.

Synced tool manifest / Registry at source commit 318fd0c