Skip to main content
Glama

List expense notes

well_list_expense_notes
Read-only

List the expense notes of the person who asks: payments they made with their own money for a company, which the company owes them back. It writes nothing.

With scope: "mine" (the default) it returns the notes this workspace holds (a company workspace) and the notes whose payment sits in this workspace (the person's own workspace), the 50 newest by expense_date. With scope: "company" it returns the notes the workspace holds, the 50 newest by expense_date, a read open only to an owner or an admin of that workspace. Each note carries the company workspace that owes it (company_workspace_id, company_workspace_name), the person's payment (source_workspace_id, transaction_id — null on the company scope, whose callers hold no read on the payer's personal workspace), the receipt when one is on file (invoice_id), amount as a decimal string in major units of currency (a magnitude, never signed), expense_date (YYYY-MM-DD) and description.

Each note also carries settlement: whether the company paid it back, computed at read time from the bank movements the call may touch and never stored. settlement.state is settled when the company paid the amount back (settlement.transaction_id names the bank movement that did), open when no payback movement stands, and to_check when the read cannot decide — the relevant feed could not be read or a same-amount movement does not identify its counterparty well enough. Never re-derive it yourself: read settlement.state as given. An empty list means the person recorded no note here, not that nothing is owed.

success: false means the read failed, for example when the call names no person (an API key), or when scope: "company" was asked by a caller who is not an owner or an admin. Never say the person has no expense note then.

When the token authorizes one workspace, call this directly — no workspace call is needed first. When it authorizes several, this read will not guess which one you mean: pass workspace_id on the call.

Input Schema

NameRequiredDescriptionDefault
scopeNo
workspace_idNoTarget workspace. Omit when the token authorizes one workspace. Required when it authorizes several: this read reports one workspace's own figures and will not choose which.
conversation_idNoThe conversation id returned by the previous Well result, in its meta under well/conversation_id, in its structuredContent, or in its JSON text block. Pass it back on every call in the same conversation, including a call a card makes, so the chosen workspace and the earlier answers still apply. It decides the conversation on its own: nothing the host states about the session replaces it. Omit it only on the first call of a conversation.
workspace_scopeNoRestrict this call to the family: the token's primary workspace plus the company workspaces under it that you are a member of. Unrelated authorized workspaces drop out of the read; row reads merge across the family, while a per-workspace figure still reports exactly one workspace.

Output Schema

NameRequiredDescriptionDefault
errorNo
successYes
expense_notesNo
conversation_idNoThe conversation this result belongs to. Pass it back as the conversation_id argument on every later Well call in the same conversation.
newly_connectedNoTools that connected to this workspace since the last result and that no session was told about yet, oldest first. Present only when at least one tool is new. The connected-line rule says when to tell an entry; when it does, one line per entry, in the person's language: "<name> is connected.". Never fold several entries into one sentence. Each entry comes back once, on one result only: never repeat its line later.
resolved_workspaceNoThe workspace that answered, when the caller named none and the token authorizes several.
conversation_id_noteNoPresent only when the server opened a fresh lane, stating that no choice recorded earlier was read.
conversation_id_sourceNoWhere the conversation id came from: the host's own request meta, the caller's argument, or a fresh lane the server opened.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed13 schema fields changed
    • removedOutput schema / properties / expense_notes / items / properties / company_workspace_name / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / expense_notes / items / properties / company_workspace_name / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / expense_notes / items / properties / description / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / expense_notes / items / properties / description / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / expense_notes / items / properties / invoice_id / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / expense_notes / items / properties / invoice_id / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • changedOutput schema / properties / expense_notes / items / properties / settlement / anyOf
      Previous value: -[
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "state": {
      -        "enum": [
      -          "settled",
      -          "open",
      -          "to_check"
      -        ],
      -        "type": "string"
      -      },
      -      "transaction_id": {
      -        "anyOf": [
      -          {
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ]
      -      }
      -    },
      -    "required": [
      -      "state",
      -      "transaction_id"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "state": {
      +        "enum": [
      +          "settled",
      +          "open",
      +          "to_check"
      +        ],
      +        "type": "string"
      +      },
      +      "transaction_id": {
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      }
      +    },
      +    "required": [
      +      "state",
      +      "transaction_id"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • removedOutput schema / properties / expense_notes / items / properties / source_workspace_id / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / expense_notes / items / properties / source_workspace_id / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / expense_notes / items / properties / transaction_id / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / expense_notes / items / properties / transaction_id / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / resolved_workspace / properties / name / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / resolved_workspace / properties / name / type
      Added value: +[
      +  "string",
      +  "null"
      +]
  2. Changed3 schema fields changed
    • addedInput schema / properties / scope
      Added value: +{
      +  "enum": [
      +    "mine",
      +    "company"
      +  ],
      +  "type": "string"
      +}
    • addedOutput schema / properties / expense_notes / items / properties / settlement
      Added value: +{
      +  "anyOf": [
      +    {
      +      "additionalProperties": false,
      +      "properties": {
      +        "state": {
      +          "enum": [
      +            "settled",
      +            "open",
      +            "to_check"
      +          ],
      +          "type": "string"
      +        },
      +        "transaction_id": {
      +          "anyOf": [
      +            {
      +              "type": "string"
      +            },
      +            {
      +              "type": "null"
      +            }
      +          ]
      +        }
      +      },
      +      "required": [
      +        "state",
      +        "transaction_id"
      +      ],
      +      "type": "object"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ]
      +}
    • changedOutput schema / properties / expense_notes / items / required
      Previous value: -[
      -  "expense_note_id",
      -  "company_workspace_id",
      -  "company_workspace_name",
      -  "source_workspace_id",
      -  "transaction_id",
      -  "invoice_id",
      -  "amount",
      -  "currency",
      -  "expense_date",
      -  "description",
      -  "recorded_at"
      -]New value: +[
      +  "expense_note_id",
      +  "company_workspace_id",
      +  "company_workspace_name",
      +  "source_workspace_id",
      +  "transaction_id",
      +  "invoice_id",
      +  "amount",
      +  "currency",
      +  "expense_date",
      +  "description",
      +  "recorded_at",
      +  "settlement"
      +]
  3. Changed1 schema field changed
    • changedOutput schema / properties / newly_connected / description
      Previous value: -"Tools that connected to this workspace since the last result and that no session was told about yet, oldest first. Present only when at least one tool is new. Start the reply with one line per entry, in the person's language: \"<name> is connected.\". Never fold several entries into one sentence. Each entry comes back once, on one result only: never repeat its line later."New value: +"Tools that connected to this workspace since the last result and that no session was told about yet, oldest first. Present only when at least one tool is new. The connected-line rule says when to tell an entry; when it does, one line per entry, in the person's language: \"<name> is connected.\". Never fold several entries into one sentence. Each entry comes back once, on one result only: never repeat its line later."
  4. Added

TDQS

A4.6/5.0
Behavior5/5

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

Goes well past the readOnlyHint=true annotation: it discloses the permission gate on company scope, the null transaction_id for company callers and why, that amounts are unsigned magnitudes, that `settlement` is computed at read time and never stored with an explicit 'never re-derive it yourself' instruction, and that success:false is a failure rather than an empty result. That last point is exactly the kind of trap an agent would otherwise fall into.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with purpose, then scope, then return shape, then failure semantics, then workspace selection — a sensible order. The long sentence enumerating returned fields is somewhat redundant given an output schema exists, but it carries real semantics (unsigned amount, null transaction_id on company scope), so nearly every clause earns its place.

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?

Covers everything an agent needs to call this correctly despite four optional parameters and two scope modes: default behaviour, permission requirements, the workspace ambiguity rule, the meaning of an empty list, and the failure signal. Because the output schema already defines the payload, the description's field enumeration is a bonus rather than a gap-filler.

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?

At 75% schema coverage the baseline is around 3, and the description earns above that by giving `scope: "mine"` an explicit default, tying `company` to an owner/admin requirement, and restating the workspace_id rule with its rationale ('this read will not guess which one you mean'). `conversation_id` and `workspace_scope` are left entirely to the schema, which is acceptable since those schema descriptions are self-contained.

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?

States a specific verb and resource ('List the expense notes of the person who asks') and immediately disambiguates the concept with a plain-language gloss ('payments they made with their own money ... which the company owes them back'). It also splits the resource by scope ('mine' vs 'company'), so an agent knows exactly which slice it is fetching without opening the schema.

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

Usage Guidelines4/5

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

Explicit conditions for each mode: default scope 'mine', 'company' scope being read-only for owners/admins, and the workspace_id rule ('when the token authorizes one workspace, call this directly — when it authorizes several ... pass workspace_id'). It does not name the complementary siblings (well_record_expense_note, well_list_expense_groups), so an agent must infer when to record vs list, but the in-tool routing guidance is otherwise strong.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources