Search Workday documentation
search_workday_docsSearch Workday developer documentation by concept, widget, API, or task. Returns lightweight pointers (title, breadcrumb, doc_id, link) for targeted follow-up reading. Filter by section and limit results.
Instructions
Search the Workday developer documentation by concept, widget, API, or task.
Returns lightweight pointers (title, breadcrumb, doc_id, link) — NOT full page text. Call get_workday_doc with a returned doc_id to read a page.
When the full-text index is built (npm run build-index), this searches page BODIES (BM25), so intent/how-to phrasing works well — e.g. "sortable grid with pagination", "format a date in a PMD expression". Without the index it falls back to TITLE-only matching (engine="title"), where specific how-to phrasing may return weak hits — build the index for best results. The response 'engine' field tells you which mode ran.
Args:
query (string): concept/widget/API/task, e.g. "validate a field on submit"
section ('Extend Apps' | 'Integration Apps' | 'Workday APIs' | 'Workday Developer Copilot'): optional filter
limit (number): max results, 1-50 (default 10)
Returns: { query_echo, engine, count, results: [{ doc_id, title, breadcrumb, html_url, score }] } Higher score = stronger match. Empty results means no match — try broader terms or browse_workday_toc.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | Concept/widget/API/task to find, e.g. 'validate a field on submit' | |
| section | No | Restrict to a top-level section | |
| limit | No | Max results (1-50) |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query_echo | Yes | ||
| engine | Yes | ||
| count | Yes | ||
| results | Yes |