Documentation
PickWise tools
Five tools your agent can call in the IDE. Most sessions only need Begin task and Log session; Save task note is optional private scratch space.
Before you start
- API key from the portal → API keys
- Your work email — the same address you use to sign in to the portal
- MCP in your IDE — follow IDE setup for config templates
Keep your API key in IDE config only — never paste it into chat or task prompts.
Quick reference
| Tool |
What it does |
When to use |
|
List my tasks
pickwise_list_my_tasks Optional
|
Shows your open assigned tasks so you can choose what to work on. |
Optional — when you want names and descriptions before picking a ticket. |
|
Begin task
pickwise_begin_task
|
Starts your ticket and loads the published standard into the agent in one step. |
When you are ready to work — you know the ticket (e.g. PROJ-123) or picked one from the list. |
|
Save task note
pickwise_save_task_note Optional
|
Saves your private resume note for a task so you can pick up where you left off. |
Before pausing, switching tasks, or end of day — not for org-visible evidence. |
|
Load standard
pickwise_load_standard Optional
|
Re-loads a published standard you already have — for example after an update was published. |
Optional — only when you need a fresh copy. Most sessions only need Begin task. |
|
Log session
pickwise_log_session
|
Records what the agent did — decisions followed, gaps found, and a written summary. |
When a coding stretch is done — one main log per context, plus optional follow-up summaries. |
|
Ask PickWise
pickwise_ask Optional
|
Searches your organisation's standards, session summaries, and recommendations. |
Optional — when the loaded task standard does not answer your question. |
Tool
pickwise_list_my_tasks
Shows your open assigned tasks so you can choose what to work on.
When: Optional — when you want names and descriptions before picking a ticket.
Try asking your agent
“List my PickWise tasks.”
Parameters
| Name | | Description |
limit |
Optional |
How many tasks to show (default 5, maximum 20). |
You get back
- Task name, description, ticket reference, and status
- Standard ID for each task
- Whether the standard is published and ready to begin
Tool
pickwise_begin_task
Starts your ticket and loads the published standard into the agent in one step.
When: When you are ready to work — you know the ticket (e.g. PROJ-123) or picked one from the list.
Try asking your agent
“Begin PickWise task PROJ-123.”
Parameters
| Name | | Description |
task_ref |
Optional |
Ticket reference, e.g. PROJ-123. Use this or the standard ID, not both. |
pack_id |
Optional |
Standard ID from the task list (API field: pack_id). Use this or task_ref, not both. |
Advanced (usually not needed)
| Name | | Description |
cached_published_at |
Optional |
Skip re-downloading if the standard has not changed. |
force_refresh |
Optional |
Always download the standard again. |
You get back
- The full standard for the agent to follow
- Decision IDs to use when logging the session
- Short task context (ticket, name, project)
- Your private resume note when you saved one earlier (null otherwise)
resume_note is private scratch context — not visible in Sessions or the portal.
Tool
pickwise_save_task_note
Saves your private resume note for a task so you can pick up where you left off.
When: Before pausing, switching tasks, or end of day — not for org-visible evidence.
Try asking your agent
“Save my PickWise task note for PROJ-123: …”
Parameters
| Name | | Description |
task_ref |
Optional |
Ticket reference. Use this or the standard ID, not both. |
pack_id |
Optional |
Standard ID (API field: pack_id). Use this or task_ref, not both. |
note |
Required |
Private resume text — max 3000 characters. Empty clears the note. |
You get back
- Confirmation with saved note body and timestamps
- max_length (3000) as a reminder
One note per task per developer (upsert). Not shown in the portal. Use pickwise_log_session for evidence.
Tool
pickwise_load_standard
Re-loads a published standard you already have — for example after an update was published.
When: Optional — only when you need a fresh copy. Most sessions only need Begin task.
Try asking your agent
“Refresh PickWise standard pp_…”
Parameters
| Name | | Description |
pack_id |
Required |
Standard ID. |
Advanced (usually not needed)
| Name | | Description |
cached_published_at |
Optional |
Skip download if unchanged. |
force_refresh |
Optional |
Always download again. |
You get back
- Updated standard markdown (when changed)
- Decision IDs for logging
Tool
pickwise_log_session
Records what the agent did — decisions followed, gaps found, and a written summary.
When: When a coding stretch is done — one main log per context, plus optional follow-up summaries.
Try asking your agent
“Log my PickWise session for this task.”
Parameters
| Name | | Description |
pack_id |
Required |
Same standard as the task you began. |
events |
Optional |
Each decision: applied or not applied, with a short evidence note. |
recommendations |
Optional |
Gaps in the standard — title and why it should be added. |
summary |
Optional |
Written close-out. Required when you mark the session complete. |
complete |
Optional |
Set true when this log is finished. |
task_ref |
Optional |
Ticket reference, e.g. PROJ-123. |
sync_to_jira |
Optional |
Default on — posts the summary to the linked ticket when complete. Turn off to keep it in PickWise only. |
Advanced (usually not needed)
| Name | | Description |
session_kind |
Optional |
standards (main), qa_handoff, pm_assurance, perspective, prompt_feedback. |
prompting_effectiveness_rating |
Optional |
1–10 when logging prompt feedback. |
You get back
- Confirmation of what was saved
- Counts of decisions logged
PickWise creates the session for you — do not pass a session ID from your IDE chat.
Tool
pickwise_ask
Searches your organisation's standards, session summaries, and recommendations.
When: Optional — when the loaded task standard does not answer your question.
Try asking your agent
“Ask PickWise: how do we handle API errors?”
Parameters
| Name | | Description |
question |
Required |
Your question in plain language. |
Advanced (usually not needed)
| Name | | Description |
messages |
Optional |
Optional follow-up history for multi-turn questions. |
You get back
- Answer grounded in indexed org content
- Citations with source type, title, and excerpt
If Ask PickWise isn't included for your account, continue from your task standard and log gaps at close-out.