Skip to main content
Glama
Proofpane

Proofpane

Official
by Proofpane

ingest_to_rag

Upload a local document into the Proofpane governance RAG corpus for governed retrieval: the cloud parses, DLP-scrubs, chunks, embeds, and audits it so contents are searchable by collection.

Instructions

Upload a LOCAL file into the Proofpane governance RAG corpus. The cloud parses it (PDF / DOCX / HTML / text), DLP-scrubs secrets, chunks + embeds it, and audits the ingest. After this, the file's contents are searchable with search_compliance_docs on the returned collection. Use when the user wants a local document made available for governed retrieval / Q&A.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "path": "<path>"
    },
    "name": "ingest_to_rag"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYesAbsolute (or cwd-relative) path to the local file to ingest.
collectionNoOptional target collection, one of the organisation's own: a name starting with 'ai_gov_<organisation id>_', or one of its per-case collections. Any other name, a shared corpus among them, is refused (404). Omit to use the org's default upload collection.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.1.4
    • changedInput schema / properties / collection / description
      Previous value: -"Optional target collection. Must start with 'ai_gov_' (tenant-namespaced). Omit to use the org's default upload collection."New value: +"Optional target collection, one of the organisation's own: a name starting with 'ai_gov_<organisation id>_', or one of its per-case collections. Any other name, a shared corpus among them, is refused (404). Omit to use the org's default upload collection."
  2. Addedv0.1.3
  3. Removedv0.1.1
  4. First observedv0.1.0

TDQS

A4.2/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description carries the whole burden and does well: it discloses that the cloud parses, DLP-scrubs secrets, chunks and embeds, and writes an audit record, which tells the agent about network upload, content mutation (secret removal) and an audit side effect. Missing are permission/auth requirements, idempotency or duplicate handling on re-ingest, and typical latency or size limits.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three tightly packed sentences: action first, then the processing pipeline, then the follow-up and the usage trigger. No filler, and the most decision-relevant information is front-loaded.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a two-parameter ingest tool with no output schema, the definition covers input nature, processing side effects, and the resulting retrieval path. It could go further on what the ingest returns (document/collection identifiers) and on re-ingest behavior, but nothing essential to invoking it correctly is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so both 'path' and 'collection' are already documented in detail, including the refusal rule for shared corpora. The description only reinforces the local-file nature of the path; it adds no syntax, format, or default behavior beyond what the schema already states, so the baseline of 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Specific verb plus resource plus target: 'Upload a LOCAL file into the Proofpane governance RAG corpus.' It clarifies the local-file input, names the destination corpus, and points at the sibling search_compliance_docs for what happens afterward, so an agent can tell this apart from read/search siblings.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicit trigger given: 'Use when the user wants a local document made available for governed retrieval / Q&A.' It also names the follow-up tool and condition ('searchable with search_compliance_docs on the returned collection'). It does not state when NOT to use it (e.g. remote URLs or already-ingested files), so it falls short of a 5.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.