Tool Details: file_read

Basic Information

Tool Name:file_read
Asset Name:Read File
Description:Read a file from a configured filesystem root. The 'mode' parameter controls decoding: 'auto' (default) returns UTF-8 text for text files and base64 for binary; 'text' forces UTF-8; 'bytes' returns base64; 'json' parses as JSON and returns the value. The encoding field on the response indicates which path was taken. Path may be either relative ('foo.txt') or rooted ('/foo.txt'); both refer to the same file inside the root.
Adapter:file
Asset Hash:0x10728e9886b13d40694903fe86337a4ac1aa910612e3b02f77bc8b7e07e0c23d
Input
PropertyTypeDescription
root*stringConfigured root name
modestringDecoding mode (default 'auto')
path*stringFile path relative to the root
Output
PropertyTypeDescription
sizeintegerFile size in bytes
encodingstring'utf-8' or 'base64' (absent for mode=json)
contentstringFile content for modes auto/text/bytes (text or base64)
mimestringBest-guess MIME type from extension and content sniffing
valueanyParsed JSON value (mode=json only)

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-3.covia.ai/mcp

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

url = "https://venue-3.covia.ai/mcp"
payload = {
    "jsonrpc": "2.0",
    "id": 1,
    "method": "tools/call",
    "params": {
        "name": "file_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-3.covia.ai/mcp';
const payload = {
    jsonrpc: '2.0',
    id: 1,
    method: 'tools/call',
    params: {
        name: 'file_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 File",
  "description": "Read a file from a configured filesystem root. The 'mode' parameter controls decoding: 'auto' (default) returns UTF-8 text for text files and base64 for binary; 'text' forces UTF-8; 'bytes' returns base64; 'json' parses as JSON and returns the value. The encoding field on the response indicates which path was taken. Path may be either relative ('foo.txt') or rooted ('/foo.txt'); both refer to the same file inside the root.",
  "creator": "Covia",
  "operation": {
    "adapter": "file:read",
    "toolName": "file_read",
    "input": {
      "type": "object",
      "properties": {
        "root": { "type": "string", "description": "Configured root name" },
        "path": { "type": "string", "description": "File path relative to the root" },
        "mode": { "type": "string", "enum": ["auto", "text", "bytes", "json"], "description": "Decoding mode (default 'auto')" }
      },
      "required": ["root", "path"]
    },
    "output": {
      "type": "object",
      "properties": {
        "content": { "type": "string", "description": "File content for modes auto/text/bytes (text or base64)" },
        "value": { "description": "Parsed JSON value (mode=json only)" },
        "encoding": { "type": "string", "description": "'utf-8' or 'base64' (absent for mode=json)" },
        "size": { "type": "integer", "description": "File size in bytes" },
        "mime": { "type": "string", "description": "Best-guess MIME type from extension and content sniffing" }
      }
    }
  }
}

Navigation

Back to adapter details

Back to all adapters

Back to index