Well

List document events

well_list_document_events

Read-only

List what happened to one document in Well, oldest first: each step of its processing (extraction started, text read, categorized, extracted or failed, a duplicate skipped, a statement promoted, a match to a transaction, a ledger posting, an enrichment) with its label, detail, status and time.

Use it to answer "what happened to this receipt?", "why is this invoice still processing?" or "when was this file read?". Pass the document_id. Page with cursor from the previous result's next_cursor. A document of another workspace, a deleted document, or one with no event, returns an empty list.

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

Name	Required	Description
`limit`	No	Events to return, at most 500. Default 50.
`cursor`	No	The next_cursor of the previous page.
`document_id`	Yes	The document_id of the document whose events to list.
`workspace_id`	No	Target 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_id`	No	The 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_scope`	No	Restrict 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

Name	Required	Description
`error`	No
`events`	No
`success`	Yes
`next_cursor`	No
`conversation_id`	No	The conversation this result belongs to. Pass it back as the conversation_id argument on every later Well call in the same conversation.
`newly_connected`	No	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.
`resolved_workspace`	No	The workspace that answered, when the caller named none and the token authorizes several.
`conversation_id_note`	No	Present only when the server opened a fresh lane, stating that no choice recorded earlier was read.
`conversation_id_source`	No	Where 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.

Changed6 schema fields changedOct 28, 2026
- removedOutput schema / properties / events / items / properties / detail / anyOf
```
Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]
```
- addedOutput schema / properties / events / items / properties / detail / type
```
Added value: +[
+  "string",
+  "null"
+]
```
- removedOutput schema / properties / next_cursor / anyOf
```
Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]
```
- addedOutput schema / properties / next_cursor / 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"
+]
```
AddedOct 14, 2026

TDQS

A4.8/5.0

Behavior5/5

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

Annotations already declare readOnly/non-destructive/closed-world, but the description adds substantial context beyond them: oldest-first ordering, empty-list semantics for out-of-scope or deleted documents, and the token-scope rule governing whether workspace_id is needed. This is exactly the extra behavior an agent cannot infer from the annotation block.

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-loads the core purpose and enumerates events in one sentence, then layers usage examples and workspace rules. The event enumeration is long but each item earns its place by defining return contents; the workspace paragraph is slightly repetitive with the schema but still purposeful.

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 an output schema present, the description needn't describe return shape, and it still covers ordering, pagination, edge cases, and the workspace/conversation scoping model. For a 6-parameter read tool with an output schema, nothing essential 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, but the description adds conditional meaning: document_id is the target document, cursor comes from the previous result's next_cursor, and workspace_id is only required when the token authorizes multiple workspaces. It does not explain limit or workspace_scope beyond the schema, so it earns a 4 rather than a 5.

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?

Opens with a specific verb and resource ('List what happened to one document in Well') and enumerates the exact event types returned, so an agent knows precisely what the tool yields. No sibling in the list serves the same per-document audit-trail purpose, and the description makes that scope unmistakable.

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?

Gives concrete eliciting questions ('what happened to this receipt?', 'why is this invoice still processing?'), states the required document_id, explains pagination via next_cursor, and pre-answers edge cases (other workspace, deleted document, no events → empty list). The multi-workspace branching rule about passing workspace_id is explicit when-to-use guidance.

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

All Well tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources

Need Help?