[Java] Align inline tool docs with final lambda API and ADR links#1885
Conversation
edburns
left a comment
There was a problem hiding this comment.
@copilot CRITICAL: Your branch was created from the wrong base. You MUST rebase your branch onto edburns/1810-java-tool-ergonomics-tool-as-lambda immediately. The plan files and context referenced in issue #1884 only exist on edburns/1810-java-tool-ergonomics-tool-as-lambda. Run: git rebase origin/edburns/1810-java-tool-ergonomics-tool-as-lambda and force-push. Do this BEFORE any other work.
Dismissing - base branch already fixed via PR edit.
|
@copilot The PR base branch has been corrected to |
Co-authored-by: edburns <75821+edburns@users.noreply.github.com>
- README: Added inline lambda tool authoring section with ToolDefinition.from(...) examples - Documented Param.of(...) required/default behavior and fluent modifiers - ADR-006: Updated to reflect final API (Param.of vs Params.of/ParamDef) - ADR-006: Added ADR-005 cross-reference and README coverage note - Plan: Marked Phase 4.6 as complete Fixes #1884 Co-authored-by: edburns <75821+edburns@users.noreply.github.com>
Completed in commit cf82a90. Documentation updates include:
Note: |
There was a problem hiding this comment.
Pull request overview
Updates Java documentation to match the shipped “tool-as-lambda” API surface (inline ToolDefinition.from* factories, Param<T> metadata, and fluent modifiers), plus tightens ADR cross-references and marks Phase 4.6 documentation work as complete.
Changes:
- Added a new experimental README section documenting inline lambda tool definitions and key factory variants (
from*,from*WithToolInvocation). - Updated ADR-006 to use the final API names (
Param.of,@CopilotToolParam,ToolDefinition.fromObject(...)) and explicitly list the implemented factory family. - Marked Phase 4.6 documentation updates as completed in the implementation plan.
Show a summary per file
| File | Description |
|---|---|
java/README.md |
Adds inline lambda tool docs/examples and lists fluent modifiers. |
java/docs/adr/adr-006-tool-definition-inline.md |
Aligns ADR examples and terminology with the final shipped API and links ADR-005. |
1810-java-tool-ergonomics-tool-as-lambda-remove-before-merge/1810-ignorance-reduction-for-implementation-plan.md |
Updates Phase 4.6 checkbox to completed. |
Review details
- Files reviewed: 3/3 changed files
- Comments generated: 2
- Review effort level: Low
… ToolDefer.ALWAYS - Added missing import statement to make the async handler code example self-contained and compilable. - Removed ALWAYS from ToolDefer values list; enum only has NONE, AUTO, NEVER. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
05d9f67
into
edburns/1810-java-tool-ergonomics-tool-as-lambda
Phase 4.6 focused on documentation parity for Java tool-as-lambda ergonomics: README examples and ADR-006 needed to reflect the shipped API surface and cross-reference the ADR chain clearly. This updates Java docs to match final inline tool definitions (
from*factories,Param<T>, and fluent modifiers) and completes the implementation-plan bookkeeping.README: inline lambda tool authoring
ToolDefinition.from(...).Param.of(...)required/default behavior and fluent option modifiers (skipPermission,defer,overridesBuiltInTool).ToolInvocation-aware inline example and pointed to ADR-006 for design context.ADR-006: final API name/usage alignment
Params.of/ParamDef) with actual API (Param.of).@CopilotToolParam,ToolDefinition.fromObject(...)).Plan bookkeeping