Skip to content

Commit 10510d4

Browse files
authored
docs: remove meta tools implementation details from README (#40)
* docs: remove meta tools implementation details from README 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") * chore: link to ENG-11260 Related: ENG-11260 * docs: remove MCP implementation references from README 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
1 parent 6547388 commit 10510d4

File tree

1 file changed

+6
-30
lines changed

1 file changed

+6
-30
lines changed

README.md

Lines changed: 6 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ StackOne AI provides a unified interface for accessing various SaaS tools throug
1414
- Glob pattern filtering with patterns like `"hris_*"` and exclusions `"!hris_delete_*"`
1515
- Provider and action filtering with `fetch_tools()`
1616
- Multi-account support
17-
- Dynamic MCP-backed discovery via `fetch_tools()` so you can pull the latest tools at runtime (accounts, providers, or globbed actions)
18-
- **Meta Tools** (Beta): Dynamic tool discovery and execution based on natural language queries using hybrid BM25 + TF-IDF search
17+
- Dynamic discovery via `fetch_tools()` so you can pull the latest tools at runtime (accounts, providers, or globbed actions)
18+
- **Meta Tools** (Beta): Dynamic tool discovery and execution based on natural language queries
1919
- Integration with popular AI frameworks:
2020
- OpenAI Functions
2121
- LangChain Tools
@@ -25,7 +25,7 @@ StackOne AI provides a unified interface for accessing various SaaS tools throug
2525
## Requirements
2626

2727
- Python 3.9+ (core SDK functionality)
28-
- Python 3.10+ (for MCP server and CrewAI examples)
28+
- Python 3.10+ (for dynamic discovery and CrewAI examples)
2929

3030
## Installation
3131

@@ -41,7 +41,7 @@ uv add stackone-ai
4141
### Optional Features
4242

4343
```bash
44-
# Install with MCP server support (requires Python 3.10+)
44+
# Install with dynamic discovery support (requires Python 3.10+)
4545
uv add 'stackone-ai[mcp]'
4646
# or
4747
pip install 'stackone-ai[mcp]'
@@ -106,7 +106,7 @@ tools = toolset.get_tools(["hris_*", "!hris_delete_*"])
106106

107107
The `fetch_tools()` method provides advanced filtering by providers, actions, and account IDs:
108108

109-
> `fetch_tools()` uses the StackOne MCP server under the hood. Install the optional extra (`pip install 'stackone-ai[mcp]'`) on Python 3.10+ to enable dynamic discovery.
109+
> Install the optional extra (`pip install 'stackone-ai[mcp]'`) on Python 3.10+ to enable dynamic discovery.
110110
111111
```python
112112
from stackone_ai import StackOneToolSet
@@ -340,7 +340,7 @@ result = feedback_tool.call(
340340

341341
## Meta Tools (Beta)
342342

343-
Meta tools enable dynamic tool discovery and execution without hardcoding tool names. The search functionality uses **hybrid BM25 + TF-IDF search** for improved accuracy (10.8% improvement over BM25 alone).
343+
Meta tools enable dynamic tool discovery and execution without hardcoding tool names.
344344

345345
### Basic Usage
346346

@@ -358,30 +358,6 @@ execute_tool = meta_tools.get_tool("meta_execute_tool")
358358
result = execute_tool.call(toolName="hris_list_employees", params={"limit": 10})
359359
```
360360

361-
### Hybrid Search Configuration
362-
363-
The hybrid search combines BM25 and TF-IDF algorithms. You can customize the weighting:
364-
365-
```python
366-
# Default: hybrid_alpha=0.2 (more weight to BM25, proven optimal in testing)
367-
meta_tools = tools.meta_tools()
368-
369-
# Custom alpha: 0.5 = equal weight to both algorithms
370-
meta_tools = tools.meta_tools(hybrid_alpha=0.5)
371-
372-
# More BM25: higher alpha (0.8 = 80% BM25, 20% TF-IDF)
373-
meta_tools = tools.meta_tools(hybrid_alpha=0.8)
374-
375-
# More TF-IDF: lower alpha (0.2 = 20% BM25, 80% TF-IDF)
376-
meta_tools = tools.meta_tools(hybrid_alpha=0.2)
377-
```
378-
379-
**How it works:**
380-
- **BM25**: Excellent at keyword matching and term frequency
381-
- **TF-IDF**: Better at understanding semantic relationships
382-
- **Hybrid**: Combines strengths of both for superior accuracy
383-
- **Default alpha=0.2**: Optimized through validation testing for best tool discovery
384-
385361
## Examples
386362

387363
For more examples, check out the [examples/](examples/) directory:

0 commit comments

Comments
 (0)