docs(tools): add missing READMEs for Exa and Mattermost tools#7151
Open
kostasuser01gr wants to merge 2 commits into
Open
docs(tools): add missing READMEs for Exa and Mattermost tools#7151kostasuser01gr wants to merge 2 commits into
kostasuser01gr wants to merge 2 commits into
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughDocumentation updates: the Exa search README was restructured, clarified, and extended with specialized wrappers; a new Mattermost tool README was added; two internal files were reformatted with no behavioral changes. ChangesExa Search Tool README
Mattermost Tool README (new)
Small internal formatting changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip 💬 Introducing Slack Agent: The best way for teams to turn conversations into code.Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.
Built for teams:
One agent for your entire SDLC. Right inside Slack. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Review rate limit: 7/8 reviews remaining, refill in 7 minutes and 30 seconds.Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@tools/src/aden_tools/tools/exa_search_tool/README.md`:
- Around line 55-60: Add detailed parameter tables for the three specialized
wrappers—exa_search_news, exa_search_papers, and exa_search_companies—mirroring
the main tool docs: list each parameter name, type, description, default value
(e.g., exa_search_news.days_back default 7), any optional/required status, and
examples of accepted values; for exa_search_papers include year_start and its
semantics; for exa_search_companies document include_text and note differing
defaults versus other wrappers; ensure each table references the wrapper name so
readers can find exa_search_news, exa_search_papers, and exa_search_companies in
the README without reading source.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 1a8a3645-a420-4128-8823-97cdbaceed18
📒 Files selected for processing (2)
tools/src/aden_tools/tools/exa_search_tool/README.mdtools/src/aden_tools/tools/mattermost_tool/README.md
Comment on lines
+55
to
+60
| ### Specialized Search Wrappers | ||
|
|
||
| The toolkit also includes convenience wrappers for specific content types: | ||
| - **exa_search_news**: Pre-configured for recent news with `days_back` filter. | ||
| - **exa_search_papers**: Pre-configured for research papers with `year_start` filter. | ||
| - **exa_search_companies**: Pre-configured for company and startup discovery. |
There was a problem hiding this comment.
🛠️ Refactor suggestion | 🟠 Major | ⚡ Quick win
Document specialized wrapper parameters with full tables for consistency.
The specialized wrappers (exa_search_news, exa_search_papers, exa_search_companies) deserve the same detailed parameter documentation as the main tools. Currently, they only have brief descriptions, but developers need to know:
exa_search_news: Has a uniquedays_backparameter (default 7) for date filteringexa_search_papers: Has ayear_startparameter for filtering by publication yearexa_search_companies: Differentinclude_textdefaults across wrappers
Without parameter tables, developers must read the source code to understand how to use these tools effectively.
📚 Proposed documentation expansion
### Specialized Search Wrappers
-The toolkit also includes convenience wrappers for specific content types:
-- **exa_search_news**: Pre-configured for recent news with `days_back` filter.
-- **exa_search_papers**: Pre-configured for research papers with `year_start` filter.
-- **exa_search_companies**: Pre-configured for company and startup discovery.
+#### exa_search_news
+Search recent news articles (pre-configured with category="news").
+
+| Argument | Type | Required | Default | Description |
+|----------|------|----------|---------|-------------|
+| `query` | str | Yes | - | News search query (1-500 chars) |
+| `num_results` | int | No | `10` | Number of results (1-20) |
+| `days_back` | int | No | `7` | How many days back to search |
+| `include_text` | bool | No | `True` | Include article text in results |
+
+#### exa_search_papers
+Search for research papers and academic content (pre-configured with category="research paper").
+
+| Argument | Type | Required | Default | Description |
+|----------|------|----------|---------|-------------|
+| `query` | str | Yes | - | Research topic or paper search query (1-500 chars) |
+| `num_results` | int | No | `10` | Number of results (1-20) |
+| `year_start` | int | No | `None` | Only include papers published after this year |
+| `include_text` | bool | No | `False` | Include full paper text (default False for brevity) |
+
+#### exa_search_companies
+Search for companies and startups (pre-configured with category="company").
+
+| Argument | Type | Required | Default | Description |
+|----------|------|----------|---------|-------------|
+| `query` | str | Yes | - | Company search query (1-500 chars) |
+| `num_results` | int | No | `10` | Number of results (1-20) |
+| `include_text` | bool | No | `True` | Include company page text in results |📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| ### Specialized Search Wrappers | |
| The toolkit also includes convenience wrappers for specific content types: | |
| - **exa_search_news**: Pre-configured for recent news with `days_back` filter. | |
| - **exa_search_papers**: Pre-configured for research papers with `year_start` filter. | |
| - **exa_search_companies**: Pre-configured for company and startup discovery. | |
| ### Specialized Search Wrappers | |
| #### exa_search_news | |
| Search recent news articles (pre-configured with category="news"). | |
| | Argument | Type | Required | Default | Description | | |
| |----------|------|----------|---------|-------------| | |
| | `query` | str | Yes | - | News search query (1-500 chars) | | |
| | `num_results` | int | No | `10` | Number of results (1-20) | | |
| | `days_back` | int | No | `7` | How many days back to search | | |
| | `include_text` | bool | No | `True` | Include article text in results | | |
| #### exa_search_papers | |
| Search for research papers and academic content (pre-configured with category="research paper"). | |
| | Argument | Type | Required | Default | Description | | |
| |----------|------|----------|---------|-------------| | |
| | `query` | str | Yes | - | Research topic or paper search query (1-500 chars) | | |
| | `num_results` | int | No | `10` | Number of results (1-20) | | |
| | `year_start` | int | No | `None` | Only include papers published after this year | | |
| | `include_text` | bool | No | `False` | Include full paper text (default False for brevity) | | |
| #### exa_search_companies | |
| Search for companies and startups (pre-configured with category="company"). | |
| | Argument | Type | Required | Default | Description | | |
| |----------|------|----------|---------|-------------| | |
| | `query` | str | Yes | - | Company search query (1-500 chars) | | |
| | `num_results` | int | No | `10` | Number of results (1-20) | | |
| | `include_text` | bool | No | `True` | Include company page text in results | |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@tools/src/aden_tools/tools/exa_search_tool/README.md` around lines 55 - 60,
Add detailed parameter tables for the three specialized
wrappers—exa_search_news, exa_search_papers, and exa_search_companies—mirroring
the main tool docs: list each parameter name, type, description, default value
(e.g., exa_search_news.days_back default 7), any optional/required status, and
examples of accepted values; for exa_search_papers include year_start and its
semantics; for exa_search_companies document include_text and note differing
defaults versus other wrappers; ensure each table references the wrapper name so
readers can find exa_search_news, exa_search_papers, and exa_search_companies in
the README without reading source.
kostasuser01gr
force-pushed
the
docs/add-missing-tool-readmes
branch
from
5d8462d to
403f34d
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@tools/src/aden_tools/tools/exa_search_tool/README.md`:
- Line 92: Update the README entry so the bullet exactly matches the actual
returned error string "Exa search request timed out" (remove the " (30s)" suffix
from the message) and instead add a separate note or parenthetical sentence
indicating the configured timeout duration (e.g., "Note: request timeout is
30s"); reference the exact message text "Exa search request timed out" and the
timeout value "30s" when making the change.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: a8b5a6d8-dd97-4ef2-9e1f-dc5c12a3f300
📒 Files selected for processing (4)
core/framework/agent_loop/internals/cursor_persistence.pycore/framework/agent_loop/internals/vision_fallback.pytools/src/aden_tools/tools/exa_search_tool/README.mdtools/src/aden_tools/tools/mattermost_tool/README.md
✅ Files skipped from review due to trivial changes (3)
- core/framework/agent_loop/internals/vision_fallback.py
- tools/src/aden_tools/tools/mattermost_tool/README.md
- core/framework/agent_loop/internals/cursor_persistence.py
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
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.
Summary
Adds missing
README.mdfiles for the Exa search and Mattermost toolkits to improve developer onboarding and tool discoverability.Changes
tools/src/aden_tools/tools/exa_search_tool/README.mdtools/src/aden_tools/tools/mattermost_tool/README.mdThese READMEs follow the standardized format used by other tools in the repository, including descriptions, argument tables, environment variable requirements, and example usage.
Summary by CodeRabbit
New Features
Documentation
Style