Get document info
get-document-infoGets information about a document.
Use this tool when:
You have a document's UUID and want to know more details about it. e.g. who is signing it, what values its dynamic fields or metadata have, etc
Called with no include parameter, returns the document's parties, teams, details, signatories, signing settings and workflow state. Use include to name the sections you want instead - among them dynamic_fields, conditions, metadata_values, signature_blocks, summary_text, tags, timestamps, attachments and stored_files - and the response carries exactly those, so a question about one aspect of a document costs one section rather than the whole document.
The stored_files section holds what the app shows as "Internal file storage", separate from attachments: call them that when talking to the user, never "stored files".
This tool covers a single document. Whenever possible avoid calling it once per document to gather the same information about several documents: list-documents returns parties, teams, tags and timestamps for a whole list via its include parameter, and specific metadata values for a whole list via its include_metadata parameter. Pass the UUIDs you already have to its filter_document_uuids parameter to get exactly the documents you are interested in.
The default response lists both the document's parties (the contracting entities, frequently organizations) and its signatories (the individual people who sign). These are distinct: a person often signs on behalf of a party (e.g. a business) without appearing as a party, so consider the signatories — not just the parties — when answering whether a specific named person is involved in or signs a document.
The dynamic_field_visibility argument narrows the dynamic_fields section to the fields that appear in the document itself, or to the ones that do not. A field belonging to a document is not necessarily written into it: fields get added and then never placed in the text, or the passage that referred to one gets rewritten, leaving a value no reader ever sees. Not every not_visible field is idle, though. Some exist only to drive a condition deciding which clauses the document shows, so they shape the contract without appearing in it (you can use the "conditions" include option to see which fields drive which conditions). Others sit inside a passage that a currently inactive condition removes, so they would appear if that condition flipped. Use "visible" when the question is about what the contract currently says. dynamic_field_visibility has no effect unless dynamic_fields is among the returned sections.
The workflow_state object - in the response by default, and requestable via include alongside other sections - describes what can currently be done with the document: whether the signing process can be started at all, which stages the document can be moved on to and everything standing in the way of each of them (stage_transitions, whose blockers say why), whether the requesting user can start signing, and — when a checkpoint blocks progress — who still needs to approve. Use it to answer questions like "why can't I sign this yet?", "what is blocking this document?" or "who still has to sign?", answering with the full list rather than one problem at a time. It is technical state, not display content: relay it to the user as natural-language prose and never echo raw field names or snake_case values.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"document_uuid": "<document_uuid>"
},
"name": "get-document-info"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| include | No | The sections the response carries, on top of the document's identity (uuid, name, stage, document type, url) which it always carries. Naming sections means exactly those: ask for one section and you pay for one, rather than for the whole document. If omitted, these are returned: parties, teams, details, signatories, signing_settings, workflow_state. | |
| document_uuid | Yes | UUID of the document to get information about. If you don't already have the document's UUID, use the list-documents tool to find it. | |
| dynamic_field_visibility | No | Narrows the dynamic_fields section to the fields that appear in the document's content ("visible") or to the ones that do not ("not_visible"). Defaults to "all", which returns every field. Only has an effect when dynamic_fields is among the returned sections. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | URL to open the document in fynk | |
| name | No | Name of the document | |
| tags | No | The tags on the document. Tags are the account's own classification labels (e.g. relationship type, commercial significance, region), so they show which categories this account uses and can be filtered on with filter_tags. Only present when the 'tags' section is requested via the include parameter. | |
| uuid | No | Unique identifier for the document. Do not show to the user unless they ask for it | |
| stage | No | What stage the document is in currently | |
| teams | No | The teams the document is assigned to. Only present when the 'teams' section is requested via the include parameter. | |
| locale | No | Locale code, e.g. en-GB, de-AT. Absent when the document has none set. Prefer describing the locale in natural language (e.g. 'British English') rather than showing the raw code. Only present when the 'details' section is requested via the include parameter. | |
| origin | No | How the document was created. Only present when the 'details' section is requested via the include parameter. | |
| parties | No | The contracting entities on the document. Only present when the 'parties' section is requested via the include parameter. | |
| conditions | No | The document's conditions: rules over its dynamic fields deciding whether a passage of the document applies, and whether each currently holds. Use them to explain why a clause is or is not part of the document, and what would have to change to flip it. Only present when the 'conditions' section is requested via the include parameter. | |
| created_at | No | When the document was created. Only present when the 'timestamps' section is requested via the include parameter. | |
| updated_at | No | When the document was last updated. Only present when the 'timestamps' section is requested via the include parameter. | |
| archived_at | No | When the document was archived. Absent when the document is not archived. Only present when the 'timestamps' section is requested via the include parameter. | |
| attachments | No | The files attached to the document. Attachments are part of the document itself and visible to external parties. Only present when the 'attachments' section is requested via the include parameter. | |
| signatories | No | The individual people who sign the document. Distinct from parties: a signatory often signs on behalf of a party (e.g. a business), so a person may be a signatory without appearing as a party. Only present when the 'signatories' section is requested via the include parameter. | |
| _entity_type | No | Only relevant for tooling. Do not show to the user | |
| stored_files | No | The files in the document's internal file storage, as opposed to its attachments. It includes files uploaded in the document's comments. The app shows these files as "Internal file storage": call them that when talking to the user, never "stored files". Only present when the 'stored_files' section is requested via the include parameter. | |
| summary_text | No | A summary of the document content. Absent when the document has no summary. Only present when the 'summary_text' section is requested via the include parameter. | |
| document_type | No | If present, indicates what kind of document this is. Absent when the document has no type assigned | |
| dynamic_fields | No | The document's dynamic fields and their values. Only present when the 'dynamic_fields' section is requested via the include parameter. | |
| signature_type | No | eIDAS assurance level used when signing the document. Absent when none has been chosen. Only present when the 'signing_settings' section is requested via the include parameter. | |
| workflow_state | No | Gives an indication of which stage transitions, etc are possible to perform on this document. This object is technical state, not display content: when relaying it to the user, always render it as natural-language prose and never echo raw field names or snake_case values (e.g. say 'signing cannot be started yet because not every signature block has been assigned to a signatory' instead of mentioning 'can_start_signing' or 'signature_block_signatory'). Only present when the 'workflow_state' section is requested via the include parameter. | |
| metadata_values | No | The document's metadata fields and their values. Only present when the 'metadata_values' section is requested via the include parameter. | |
| signature_blocks | No | The places in the document that are signed. A block is bound either to a single signatory or to a party, in which case every signatory of that party signs it. Every signatory needs a block covering them before signing can be started. Only present when the 'signature_blocks' section is requested via the include parameter. | |
| sequential_signing | No | When true, signatories sign one at a time, in ascending order of their signing_order. Only present when the 'signing_settings' section is requested via the include parameter. | |
| source_template_uuid | No | UUID of the template the document was created from. Absent when it was not created from a template. Only present when the 'details' section is requested via the include parameter. | |
| external_signatory_invitation_message | No | Text shown in the email inviting external signatories to sign. Absent when no message is set. Only present when the 'signing_settings' section is requested via the include parameter. |