StackOne AI SDK

https://github.com/stackonehq/stackone-ai-python
Admin
StackOne AI provides a unified interface for accessing various SaaS tools through AI-friendly APIs,...
Tokens:2,182
Snippets:6
Trust Score:7.7
License:Apache-2.0
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install StackOne AI SDK

Source: https://github.com/stackonehq/stackone-ai-python/blob/main/README.md

Installs the StackOne AI Python SDK using pip. This is the first step to using the SDK in your Python projects.

```bash
pip install stackone-ai
```

--------------------------------

### Essential Development Commands

Source: https://github.com/stackonehq/stackone-ai-python/blob/main/CLAUDE.md

Provides a comprehensive list of make commands for managing the StackOne AI Python SDK project, including installation, code quality checks, testing, documentation generation, and MCP development.

```bash
# Setup and installation
make install           # Install dependencies and pre-commit hooks

# Code quality
make lint             # Run ruff linting
make lint-fix         # Auto-fix linting issues  
make mypy             # Run type checking

# Testing
make test             # Run all tests
make test-tools       # Run tool-specific tests
make test-examples    # Run example tests

# Documentation
make docs-serve       # Build and serve docs locally (http://localhost:8000)
make docs-build       # Build docs for deployment

# MCP Development
make mcp-inspector    # Run MCP server inspector for debugging
```

--------------------------------

### Initialize and Use StackOne Tools

Source: https://github.com/stackonehq/stackone-ai-python/blob/main/README.md

Demonstrates how to initialize the StackOneToolSet, retrieve tools using glob patterns (including exclusions), and execute a specific tool using both the `call` and `execute` methods.

```python
from stackone_ai import StackOneToolSet

# Initialize with API key
toolset = StackOneToolSet()  # Uses STACKONE_API_KEY env var
# Or explicitly: toolset = StackOneToolSet(api_key="your-api-key")

# Get HRIS-related tools with glob patterns
tools = toolset.get_tools("hris_*")
# Exclude certain tools with negative patterns
tools = toolset.get_tools(["hris_*", "!hris_delete_*"])

# Use a specific tool with the new call method
employee_tool = tools.get_tool("hris_get_employee")
# Call with keyword arguments
employee = employee_tool.call(id="employee-id")
# Or with traditional execute method
employee = employee_tool.execute({"id": "employee-id"})
```

--------------------------------

### Dynamic Tool Discovery and Execution with Meta Tools

Source: https://github.com/stackonehq/stackone-ai-python/blob/main/README.md

Shows how to leverage meta tools for dynamic tool discovery using natural language queries and execute discovered tools with specified parameters.

```python
# Get meta tools for dynamic discovery
tools = toolset.get_tools("hris_*")
meta_tools = tools.meta_tools()

# Search for relevant tools using natural language
filter_tool = meta_tools.get_tool("meta_filter_relevant_tools")
results = filter_tool.call(query="manage employees", limit=5)

# Execute discovered tools dynamically
execute_tool = meta_tools.get_tool("meta_execute_tool")
result = execute_tool.call(toolName="hris_list_employees", params={"limit": 10})
```

--------------------------------

### StackOneToolSet Authentication

Source: https://github.com/stackonehq/stackone-ai-python/blob/main/CLAUDE.md

Illustrates the authentication methods for the StackOneToolSet, showing how to provide an API key and an optional account ID either directly or via environment variables.

```python
# Uses environment variables or direct configuration
toolset = StackOneToolSet(
    api_key="your-api-key",  # or STACKONE_API_KEY env var
    account_id="optional-id"  # or STACKONE_ACCOUNT_ID env var
)
```

--------------------------------

### Tool Filtering with Glob Patterns

Source: https://github.com/stackonehq/stackone-ai-python/blob/main/CLAUDE.md

Demonstrates how to use glob patterns with the StackOneToolSet to include or exclude specific tools during initialization. This allows for fine-grained control over which SaaS integrations are loaded.

```python
# Use glob patterns for tool selection
tools = StackOneToolSet(include_tools=["hris_*", "!hris_create_*"])
```
Tokens:
Raw