Tool Details: vault_read

Basic Information

Tool Name:vault_read
Asset Name:Read Vault File
Description:Read a file from the user's personal vault. The 'mode' parameter controls how the file is returned: 'auto' (default) returns UTF-8 text for text files, or a reference with a WebDAV URL for binaries; 'text' forces UTF-8 decoding; 'bytes' returns base64-encoded bytes; 'json' parses the file as JSON and returns the value. For binary files, prefer the returned WebDAV URL rather than using 'bytes' mode.
Adapter:vault
Asset Hash:0xbb02149400cd79b1ef0f78918719c79fedee71cd347b04e2fc7360e92e93ebe0
Input
PropertyTypeDescription
path*stringFile path within the vault (e.g. 'documents/report-q4.json')
modestringHow to decode the file. Default 'auto'.
Output
PropertyTypeDescription
urlstringWebDAV URL to fetch raw bytes (present when encoding=binary)
mimestringBest-guess MIME type
valueanyParsed JSON value (present for mode=json only).
contentstringFile content (present for modes auto/text/bytes).
sizeintegerSize in bytes
encodingstring'utf-8', 'base64', or 'binary'.

MCP Tool Usage Examples

This tool can be called via the MCP (Model Context Protocol) endpoint. Here are examples of how to use it:

JSON-RPC Call Example:

POST to https://venue-1.covia.ai/mcp

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "vault_read",
    "arguments": {
      "input": "your input here"
    }
  }
}
cURL Example:
curl -X POST https://venue-1.covia.ai/mcp \\
  -H "Content-Type: application/json" \\
  -d '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "tools/call",
    "params": {
      "name": "vault_read",
      "arguments": {
        "input": "your input here"
      }
    }
  }'
Python Example:
import requests
import json

url = "https://venue-1.covia.ai/mcp"
payload = {
    "jsonrpc": "2.0",
    "id": 1,
    "method": "tools/call",
    "params": {
        "name": "vault_read",
        "arguments": {
            "input": "your input here"
        }
    }
}

response = requests.post(url, json=payload)
result = response.json()
print(result)
JavaScript/Node.js Example:
const fetch = require('node-fetch');

const url = 'https://venue-1.covia.ai/mcp';
const payload = {
    jsonrpc: '2.0',
    id: 1,
    method: 'tools/call',
    params: {
        name: 'vault_read',
        arguments: {
            input: 'your input here'
        }
    }
};

fetch(url, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json'
    },
    body: JSON.stringify(payload)
})
.then(response => response.json())
.then(data => console.log(data));

Asset Metadata

{
  "name": "Read Vault File",
  "description": "Read a file from the user's personal vault. The 'mode' parameter controls how the file is returned: 'auto' (default) returns UTF-8 text for text files, or a reference with a WebDAV URL for binaries; 'text' forces UTF-8 decoding; 'bytes' returns base64-encoded bytes; 'json' parses the file as JSON and returns the value. For binary files, prefer the returned WebDAV URL rather than using 'bytes' mode.",
  "creator": "Covia",
  "operation": {
    "adapter": "vault:read",
    "toolName": "vault_read",
    "input": {
      "type": "object",
      "properties": {
        "path": { "type": "string", "description": "File path within the vault (e.g. 'documents/report-q4.json')" },
        "mode": { "type": "string", "enum": ["auto", "text", "bytes", "json"], "description": "How to decode the file. Default 'auto'." }
      },
      "required": ["path"]
    },
    "output": {
      "type": "object",
      "properties": {
        "content": { "type": "string", "description": "File content (present for modes auto/text/bytes)." },
        "value": { "description": "Parsed JSON value (present for mode=json only)." },
        "encoding": { "type": "string", "description": "'utf-8', 'base64', or 'binary'." },
        "size": { "type": "integer", "description": "Size in bytes" },
        "mime": { "type": "string", "description": "Best-guess MIME type" },
        "url": { "type": "string", "description": "WebDAV URL to fetch raw bytes (present when encoding=binary)" }
      }
    }
  }
}

Navigation

Back to adapter details

Back to all adapters

Back to index