From 0b962a16e4e2df3fad944d56bb99ffa0c1bb4b54 Mon Sep 17 00:00:00 2001 From: ofir-frd Date: Tue, 29 Jul 2025 11:30:46 +0300 Subject: [PATCH] docs: improve help tool documentation with clearer usage instructions --- docs/docs/tools/help.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/docs/tools/help.md b/docs/docs/tools/help.md index a9a458e8..c7a83ce5 100644 --- a/docs/docs/tools/help.md +++ b/docs/docs/tools/help.md @@ -11,10 +11,11 @@ It can be invoked manually by commenting on any PR: ## Example usage -An example [result](https://github.com/Codium-ai/pr-agent/pull/546#issuecomment-1868524805): +Invoke the `help` tool by commenting on a PR with: -![Help 1](https://codium.ai/images/pr_agent/help1.png){width=750} +![Help tool input](https://codium.ai/images/pr_agent/help1.png){width=750} -→ -![Analyze 2](https://codium.ai/images/pr_agent/help2.png){width=750} +Response will include a list of available tools: + +![Help tool output](https://codium.ai/images/pr_agent/help2.png){width=750}