Skip to main content

well_get_schema

Discover available data types and fields.
ParameterTypeRequiredDescription
rootstringNoinvoices, companies, people, documents, connectors
depthnumberNo0=scalars, 1=relations (default), 2=nested

well_query_records

Query records from Well’s database.
ParameterTypeRequiredDescription
rootstringYesEntity type
fieldsarrayNo*Field paths as arrays, e.g. ["invoices", "grand_total"]
allFieldsbooleanNo*Fetch all scalar fields
limitnumberNoMax records (default 50, max 500)
*Either fields or allFields: true required

well_create_company

Create a new company.
ParameterTypeRequiredDescription
namestringYesCompany name
domainstringNoWebsite domain
tax_idstringNoTax ID

well_create_person

Create a new contact.
ParameterTypeRequiredDescription
first_namestringYesFirst name
last_namestringNoLast name
emailstringNoEmail address
phonestringNoPhone (E.164)

Examples

Example 1: Query financial data

User prompt:
Show me all unpaid invoices over 1000 EUR from the last 3 months
What happens:
  • Server calls well_get_schema("invoices") to discover available fields
  • Server calls well_query_records with invoice root, filtering by status and amount
  • Returns matching invoices with invoice number, amount, due date, and issuer name
  • AI presents results in a formatted table

Example 2: Create a new contact

User prompt:
Create a new contact: John Doe, email [email protected], CEO at Acme Corp
What happens:
  • Server calls well_create_company to create Acme Corp if it doesn’t exist
  • Server calls well_create_person with first_name, last_name, email, and job_title
  • Returns confirmation with the new person ID and company association
  • Contact is immediately available in your Well workspace

Example 3: Build a financial dashboard

User prompt:
Create a complete financial dashboard in React with shadcn/ui dark mode showing:
- KPI cards: Total received, Total spent, Net balance, Invoice count
- Area chart of cash flow over 12 months
- Tabs for Income, Expenses, Analytics
- Pie charts for client/supplier breakdown
- Use my actual invoice data from Well
What happens:
  • Server calls well_query_records to fetch all invoices with issuer, receiver, amounts, and dates
  • Server calls well_query_records to fetch companies data
  • AI analyzes the data structure and generates a complete React dashboard artifact
  • Dashboard displays real financial data with interactive charts (Recharts)
  • Includes filtering, sorting, and responsive dark mode design

title: ‘Tools Reference’ description: ‘Available MCP tools for Well’ icon: ‘wrench’

well_get_schema

Discover available data types and fields.
ParameterTypeRequiredDescription
rootstringNoinvoices, companies, people, documents, connectors
depthnumberNo0=scalars, 1=relations (default), 2=nested

well_query_records

Query records from Well’s database.
ParameterTypeRequiredDescription
rootstringYesEntity type
fieldsarrayNo*Field paths as arrays, e.g. ["invoices", "grand_total"]
allFieldsbooleanNo*Fetch all scalar fields
limitnumberNoMax records (default 50, max 500)
*Either fields or allFields: true required

well_create_company

Create a new company.
ParameterTypeRequiredDescription
namestringYesCompany name
domainstringNoWebsite domain
tax_idstringNoTax ID

well_create_person

Create a new contact.
ParameterTypeRequiredDescription
first_namestringYesFirst name
last_namestringNoLast name
emailstringNoEmail address
phonestringNoPhone (E.164)

Examples

Example 1: Query financial data

User prompt:
Show me all unpaid invoices over 1000 EUR from the last 3 months
What happens:
  • Server calls well_get_schema("invoices") to discover available fields
  • Server calls well_query_records with invoice root, filtering by status and amount
  • Returns matching invoices with invoice number, amount, due date, and issuer name
  • AI presents results in a formatted table

Example 2: Create a new contact

User prompt:
Create a new contact: John Doe, email [email protected], CEO at Acme Corp
What happens:
  • Server calls well_create_company to create Acme Corp if it doesn’t exist
  • Server calls well_create_person with first_name, last_name, email, and job_title
  • Returns confirmation with the new person ID and company association
  • Contact is immediately available in your Well workspace

Example 3: Build a financial dashboard

User prompt:
Create a complete financial dashboard in React with shadcn/ui dark mode showing:
- KPI cards: Total received, Total spent, Net balance, Invoice count
- Area chart of cash flow over 12 months
- Tabs for Income, Expenses, Analytics
- Pie charts for client/supplier breakdown
- Use my actual invoice data from Well
What happens:
  • Server calls well_query_records to fetch all invoices with issuer, receiver, amounts, and dates
  • Server calls well_query_records to fetch companies data
  • AI analyzes the data structure and generates a complete React dashboard artifact
  • Dashboard displays real financial data with interactive charts (Recharts)
  • Includes filtering, sorting, and responsive dark mode design

Coming Soon

The following data types are in development and will be available soon.

Payments

Query payment transactions from your connected accounts.
ParameterTypeRequiredDescription
rootstringYespayments
fieldsarrayNo*Field paths to retrieve
allFieldsbooleanNo*Fetch all scalar fields
limitnumberNoMax records (default 50, max 500)
Example use cases:
  • “Show me all payments from last month”
  • “What payments did we receive from Acme Corp?”
  • “List failed payment attempts”

Payment Means

Query and manage payment methods (cards, bank accounts, wallets).
ParameterTypeRequiredDescription
rootstringYespayment_means
fieldsarrayNo*Field paths to retrieve
allFieldsbooleanNo*Fetch all scalar fields
limitnumberNoMax records (default 50, max 500)
Example use cases:
  • “What payment methods do we have on file?”
  • “Show me all active credit cards”
  • “List bank accounts connected to our workspace”

Accounts

Query connected financial accounts (banks, payment providers, fintech integrations).
ParameterTypeRequiredDescription
rootstringYesaccounts
fieldsarrayNo*Field paths to retrieve
allFieldsbooleanNo*Fetch all scalar fields
limitnumberNoMax records (default 50, max 500)
Example use cases:
  • “What bank accounts are connected?”
  • “Show me all Stripe accounts”
  • “List accounts with pending sync”
Want early access to these features? Contact us at [email protected]