docs: remove meta tools implementation details from README #40
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
Remove references to search algorithms (BM25, TF-IDF, hybrid search) from the Meta Tools section to keep documentation focused on user-facing functionality rather than internal implementation details. Changes: - Removed mention of "hybrid BM25 + TF-IDF search" from Features section - Removed entire "Hybrid Search Configuration" section with hybrid_alpha examples - Removed technical explanations about BM25/TF-IDF algorithms - Kept focus on what users can do (discover and execute tools) Rationale: - Aligns with documentation in agents/python/meta-tools.mdx - Users don't need to know about underlying search algorithms - Implementation details can change without affecting user-facing API - Maintains consistency with Node.js SDK documentation standards - Follows SDK documentation best practices (focus on "what" and "how to use")
There was a problem hiding this comment.
Pull Request Overview
This PR simplifies the README documentation by removing internal implementation details about search algorithms from the Meta Tools section, making it more user-focused and maintainable.
- Removed references to BM25, TF-IDF, and hybrid search algorithms from user-facing documentation
- Eliminated the "Hybrid Search Configuration" subsection with code examples using
hybrid_alpha - Maintained focus on what users can do (discover and execute tools dynamically) rather than how it works internally
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
Related: ENG-11260
Remove mentions of "MCP server" and "MCP-backed" from user-facing documentation. Replace with generic "dynamic discovery" terminology. Changes: - "Dynamic MCP-backed discovery" → "Dynamic discovery" - "for MCP server and CrewAI" → "for dynamic discovery and CrewAI" - "Install with MCP server support" → "Install with dynamic discovery support" - Remove "uses the StackOne MCP server under the hood" explanation Users don't need to know about internal MCP implementation details. Related: ENG-11260
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Removes implementation details (BM25, TF-IDF, hybrid_alpha configuration) from the Meta Tools README section.
Users don't need to know about internal search algorithms to use meta tools effectively. This keeps the README focused on user-facing functionality and aligns with our documentation site.
Related: StackOneHQ/stackone-ai-node#138