querying-well-data

Installation
SKILL.md

Querying Well data

Well exposes a workspace's financial graph through three MCP tools:

  • well_get_schema() — list every available root (entity type).
  • well_get_schema({ root }) — list the fields available on one root, with types and semantic context.
  • well_query_records({ root, fields, whereClause?, orderBy?, limit? }) — read rows.
  • well_get_entity({ root, id }) — fetch one record by id.

The one rule: discover before you query

Always call well_get_schema(root) first, pick the fields you need from what it returns, then call well_query_records. Field paths are arrays: "invoices.issuer.name" → ["invoices", "issuer", "name"]. Do not guess field names — they vary by root and are documented in the schema response (each field carries a type and often a context explaining what it means).

The roots you can read

Calling well_get_schema() with no argument returns the full set. It includes far more than invoices and companies — in particular the accounting graph:

Installs
1
Repository
wellapp-ai/well
GitHub Stars
345
First Seen
7 days ago