feat: add ctx.log() for custom tools #6852
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- adds log() method to ToolContext in both plugin and internal Tool.Context - implements log() using Log.create() in tool execution contexts - updates plugin docs to show ctx.log() for custom tools - removes console.log example that leaks to stdout - fixes anomalyco#6830 anomalyco#6833
elithrar
force-pushed
the
feat/tool-context-logging
branch
from
41cf39c to
11a79c4
Compare
elithrar
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #6830 and #6833 by adding
ctx.log()for custom tools to avoid console.log output leaking to stdout.problem:
ctx.client.app.logavailable to them, but custom tools did not - there was no logger exposed to tools (making it hard to debug)solution:
ctx.log(level, message, extra)to ToolContext for custom tool implementationsLog.create()API (appropriate since tools execute in-process)ctx.log()for custom tools andclient.app.log()for plugin initializationI also had to update test sites for built-in tools to plumb
logthrough into theToolContext, hence the larger number of changed files here.Custom tools now have structured logging that writes to OpenCode's log files instead of polluting terminal output.