DealTraq Docs
Tool reference

Identity and pipeline

Tools for checking your connection, reading your fund thesis, listing companies by pipeline stage, pipeline metrics, and audit history.

These tools tell your assistant who you are, how your pipeline is organized, and which companies are in each stage. All of them are read-only.

get_dealtraq_identity

Read · Cost 1

Returns the DealTraq organization you selected during sign-in, your name, and your member role. Use it to confirm which workspace your assistant is connected to.

This tool takes no inputs.

Example: Which DealTraq organization am I connected to?

get_organization_thesis

Read · Cost 2

Reads your organization's active investment thesis, including its version number and when it was saved. If no thesis is configured, the result says NOT_CONFIGURED and your assistant should not invent a fund mandate. Administrators edit the thesis in DealTraq settings; this tool cannot change it.

This tool takes no inputs.

Example: What is our current investment thesis? Which version is active?

get_pipeline_structure

Read · Cost 2

Describes your configured pipelines and their stages in order, and which stages belong to Inbox, Pipeline, and Archived. Your assistant uses this to explain how your pipeline works or to resolve a stage name that matches more than one stage. To list the companies in a stage, it uses list_companies_in_pipeline_stage instead.

This tool takes no inputs.

Example: Walk me through our pipeline stages in order.

list_companies_in_pipeline_stage

Read · Cost 4

Lists exactly the companies currently in a stage, with each company's website, description, date added, and owners. It reads current CRM membership directly and never substitutes a search. Results come in pages, with a nextRequest for the next page and a ready-made research request for each company.

InputTypeRequiredDescription
stageNamestringOne of stageName, stageId, or locationThe stage name as you would say it, such as "Diligence".
stageIdUUIDOne of stageName, stageId, or locationAn exact stage ID.
locationINBOX, PIPELINE, or ARCHIVEDOne of stageName, stageId, or locationEvery company in that part of the CRM.
pipelineIdUUIDNoLimit the lookup to one pipeline.
sortADDED_DATE_DESC, ADDED_DATE_ASC, NAME_ASC, or NAME_DESCNoDefaults to newest first for Inbox and name A to Z for other stages, matching the DealTraq views.
limitinteger, 1 to 50NoCompanies per page. Defaults to 25.
cursorintegerNoPage position. Set by nextRequest.

Notes

  • Follow nextRequest until coverage.complete is true before treating the list as complete.
  • If a stage name is ambiguous or not found, no companies are returned and the result explains why. For an ambiguous name, nextRequest points to get_pipeline_structure.
  • If the stage's companies change between pages, the result is marked STALE and nextRequest restarts from the first page.

Example: Show me every company currently in Diligence and summarize the evidence gaps.

query_pipeline_metrics

Read · Cost 2

Returns a calculated pipeline metric along with the exact definition of the companies it counts and any limitations. The only metric currently available is active_pipeline_company_count.

InputTypeRequiredDescription
metricactive_pipeline_company_countYesThe metric to calculate.

Example: How many companies are in our active pipeline, and how does DealTraq define that?

query_audit_history

Read · Cost 3

Reads the change history for a company, a specific record, or your whole organization over a time range. Each event shows who made the change, what changed, and when. Only events you are allowed to see are returned.

InputTypeRequiredDescription
scopeobjectYesWhat to read: a company (kind: "COMPANY", companyId), a specific record (kind: "ENTITY", entityType, entityId), or the whole organization (kind: "ORGANIZATION").
fromISO date-timeFor organization scopeStart of the time range.
toISO date-timeFor organization scopeEnd of the time range.
changedFieldstringNoOnly events that changed this field.
actionsstring array, up to 25NoOnly these action types.
actorOrgMemberIdsUUID array, up to 25NoOnly changes made by these members.
includeSummarybooleanNoInclude a summary of the returned events.
limitinteger, 1 to 50NoEvents per page.
cursorstringNoPage position. Set by nextRequest.

Notes

  • Organization-wide history requires an administrator, both from and to, and a range of 31 days or less.
  • Follow nextRequest until pageCoverage.complete is true. auditCoverage separately reports whether the underlying history itself is complete, partial, or unknown for the period.

Example: Who moved Acme out of Inbox, and what else changed on it last week?

On this page