Skip to main content
Glama
talonicdev

talonic-mcp

Official
by talonicdev

List registry fields

talonic_list_fields
Read-onlyIdempotent

Discover the canonical fields in your workspace's document registry before querying. Get stable IDs, maturity levels, and synonyms to select the right concept for questions or filtering.

Instructions

List the workspace's Field Registry — the canonical concepts Talonic has discovered across every ingested document, each with a stable id, maturity level, data type, synonyms and occurrence count.

USE WHEN: you need to know WHAT data exists before querying it, want to pick the right concept for a question, or need the exact field id for talonic_get_field / talonic_field_values. NOT FOR: locating a specific document (talonic_search) or filtering documents by a value (talonic_filter).

ARGS: search (case-insensitive contains on name), maturity (core | proven | candidate — prefer core/proven for anything you will build on), include_superseded (default false: rows merged into another concept are hidden so you never see two ids for one concept), limit, cursor. RETURNS: data[] of { id, canonical_name, display_name, data_type, maturity, tier, synonyms, description, occurrence_count, superseded_by, links } plus cursor pagination.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoPage size (default 20, max 100).
cursorNoOpaque cursor from pagination.next_cursor.
searchNoCase-insensitive contains match on canonical_name / display_name.
maturityNoFilter by maturity: `core` (universal, fully trusted — safe to build on), `proven` (recurring, stable id), `candidate` (newly discovered, may still be merged or renamed).
include_supersededNoInclude rows merged into a survivor (they carry `superseded_by`). Default false.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.1.76

TDQS

A4.7/5.0
Behavior4/5

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

Annotations already establish readOnly/idempotent/destructive safety; the description adds genuinely useful behavior: merged/superseded rows are hidden by default, maturity semantics for stable vs candidate concepts, and cursor pagination with a return-shape listing. It could also mention auth requirements or rate limits, but those are not necessary for this read-only listing tool.

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?

The description is front-loaded with purpose, then structured into USE WHEN, NOT FOR, ARGS, and RETURNS. Every section earns its place, and the ARGS section is a compact summary rather than a full schema dump.

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

Completeness5/5

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

With no output schema, the RETURNS field list is essential and present. The description also covers pagination, default behavior for superseded rows, when to use the tool, and how it relates to sibling tools; no significant calling context is missing.

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

Parameters4/5

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

Schema coverage is 100%, so the baseline is 3; the description adds guidance beyond the schema by explaining why to prefer core/proven maturities and what include_superseded=false means semantically ('you never see two ids for one concept'). This is useful parameter-level context without needing to restate schema details.

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?

The description uses a specific verb ('List') with an explicit resource ('the workspace's Field Registry') and defines what those concepts are. It also distinguishes itself from siblings by stating it is not for locating documents (talonic_search) or filtering by value (talonic_filter), so an agent can select it correctly.

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

Usage Guidelines5/5

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

The USE WHEN block gives concrete triggers ('need to know WHAT data exists... need the exact field id for talonic_get_field / talonic_field_values') and the NOT FOR block names the sibling alternatives. This is explicit routing guidance rather than implied usage.

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