refactor(retrieval): clarify agent modes and list_documents usage - #436
Merged
Merged
Conversation
…tation - Updated the `use_agentic` parameter description to clearly define its role in toggling agent retrieval on or off, specifying the behavior for classic map-unit BM25 and agent modes. - Revised the `AGENT_EXPLORE_HARNESS` documentation to detail the selection between `cursor_sdk` and `openai` based on the agent retrieval state. - Adjusted related environment variable comments to reflect the new understanding of agent retrieval modes. - Enhanced flowchart and internal documentation for better clarity on retrieval processes.
…umentation - Clarified the usage of the `list_documents` tool to specify it should only be used when the user explicitly requests to list or inventory documents, rather than as a starting point for question answering. - Updated related documentation in `config.py` and `CORPUS_SCHEMA.md` to reflect these changes and improve clarity on tool usage. - Added a test to ensure the `list_documents` tool is correctly registered and behaves as expected for inventory requests.
1 task
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
use_agentic) from the harness (AGENT_EXPLORE_HARNESS) in API docs, env examples, and AGENTS.md so Cursor vs Knowhere's own agent is not treated as the same toggle.list_documentsto explicit inventory requests; it stays registered, but is no longer the default cold start for question answering.Test plan
make check(lint + typecheck)uv run pytest shared/tests/test_agent_explore_harness.py(30 passed)Made with Cursor