Tool Details: covia_list

Basic Information

Tool Name:covia_list
Asset Name:List Lattice Structure
Description:List keys at a lattice path with pagination. Returns type, count, and a (paginated) key array — values are not fetched. Use when you need just the keys of a known map (e.g. iterating agents under g/) or when paginating a large collection. For discovery and exploration use covia_inspect, which is budget-bounded and shows shape and sample values in one call. covia_slice paginates values; this paginates keys.
Adapter:covia
Asset Hash:0xc84312f8ee8e0bb3fbd131f3eeb1e6e7bd55c2b938f989fafb6ce193505419da
Input
PropertyTypeDescription
pathanyAny resolvable lattice path. Examples: 'v/ops' (venue catalog), 'o' (your pins), 'v/info/adapters' (installed adapters), 'g/my-agent' (agent record), 'w/notes'. Omit to describe the top-level of your namespace.
offsetintegerNumber of map keys to skip (default 0). Only applies to map types.
limitintegerMaximum map keys to return (default 1000). Only applies to map types.
fieldsanyOptional field projection (partial response): subpaths to read from each listed child, e.g. ["status", "meta/updated"] or one comma-separated string. Adds a 'values' map to the response with each field's read result per key. Max 16 fields; applies after limit/offset; requires a keyed node. Output shape only — no filtering or ordering.
Output
PropertyTypeDescription
typestringConvex type name, e.g. Map, Vector, Index, Set, String, Long, Boolean, Double, Blob, Nil.
existsbooleanTrue if data exists at this path
keysarrayKeys of a keyed collection (map or Index), may be paginated. Positional collections (vector, set) return type+count only — read elements via covia_slice.
countintegerTotal element count of the collection (maps, vectors, sets, indices).
valuesobjectPresent when 'fields' was given: per listed key, each requested field's read result {exists, value, truncated?} — single-read semantics per field.
offsetintegerStarting index of the returned key page (present for keyed listings).

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

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

url = "https://venue-test.covia.ai/mcp"
payload = {
    "jsonrpc": "2.0",
    "id": 1,
    "method": "tools/call",
    "params": {
        "name": "covia_list",
        "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-test.covia.ai/mcp';
const payload = {
    jsonrpc: '2.0',
    id: 1,
    method: 'tools/call',
    params: {
        name: 'covia_list',
        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": "List Lattice Structure",
	"description": "List keys at a lattice path with pagination. Returns type, count, and a (paginated) key array — values are not fetched. Use when you need just the keys of a known map (e.g. iterating agents under g/) or when paginating a large collection. For discovery and exploration use covia_inspect, which is budget-bounded and shows shape and sample values in one call. covia_slice paginates values; this paginates keys.",
	"dateCreated": "2026-03-07T00:00:00Z",
	"operation": {
		"adapter": "covia:list",
		"toolName": "covia_list",
		"input": {
			"type": "object",
			"properties": {
				"path": {
					"description": "Any resolvable lattice path. Examples: 'v/ops' (venue catalog), 'o' (your pins), 'v/info/adapters' (installed adapters), 'g/my-agent' (agent record), 'w/notes'. Omit to describe the top-level of your namespace."
				},
				"limit": {
					"type": "integer",
					"description": "Maximum map keys to return (default 1000). Only applies to map types."
				},
				"offset": {
					"type": "integer",
					"description": "Number of map keys to skip (default 0). Only applies to map types."
				},
				"fields": {
					"description": "Optional field projection (partial response): subpaths to read from each listed child, e.g. [\"status\", \"meta/updated\"] or one comma-separated string. Adds a 'values' map to the response with each field's read result per key. Max 16 fields; applies after limit/offset; requires a keyed node. Output shape only — no filtering or ordering."
				}
			}
		},
		"output": {
			"type": "object",
			"properties": {
				"exists": { "type": "boolean", "description": "True if data exists at this path" },
				"type": { "type": "string", "description": "Convex type name, e.g. Map, Vector, Index, Set, String, Long, Boolean, Double, Blob, Nil." },
				"count": { "type": "integer", "description": "Total element count of the collection (maps, vectors, sets, indices)." },
				"keys": { "type": "array", "description": "Keys of a keyed collection (map or Index), may be paginated. Positional collections (vector, set) return type+count only — read elements via covia_slice." },
				"offset": { "type": "integer", "description": "Starting index of the returned key page (present for keyed listings)." },
				"values": { "type": "object", "description": "Present when 'fields' was given: per listed key, each requested field's read result {exists, value, truncated?} — single-read semantics per field." }
			}
		}
	}
}

Navigation

Back to adapter details

Back to all adapters

Back to index