forked from Rockachopa/Timmy-time-dashboard
Co-authored-by: Alexander Whitestone <alexpaynex@gmail.com> Co-committed-by: Alexander Whitestone <alexpaynex@gmail.com>
2.0 KiB
2.0 KiB
name, type, typical_query_count, expected_output_length, cascade_tier, description
| name | type | typical_query_count | expected_output_length | cascade_tier | description |
|---|---|---|---|---|---|
| Integration Guide | research | 3-5 | 1000-2000 words | groq_preferred | Step-by-step guide to wire a specific tool into an existing stack, complete with code samples, configuration, and testing steps. |
Integration Guide: Wire {tool} into {stack}
Context
Integrate {tool} into our {stack} stack. The goal is to {integration_goal} (e.g., "add vector search to the dashboard", "send notifications via Telegram").
Constraints
- Must follow existing project conventions (see CLAUDE.md).
- No new cloud AI dependencies unless explicitly approved.
- Environment config via
pydantic-settings/config.py.
Research Steps
- Review {tool}'s official documentation for installation and setup.
- Identify the minimal dependency set required.
- Map {tool}'s API to our existing patterns (singletons, graceful degradation).
- Write integration code with proper error handling.
- Define configuration variables and their defaults.
Output Format
Prerequisites
- Dependencies to install (with versions)
- External services or accounts required
- Environment variables to configure
Configuration
# In config.py — add these fields to Settings:
{config_fields}
Implementation
# {file_path}
{implementation_code}
Graceful Degradation
Describe how the integration behaves when {tool} is unavailable:
| Scenario | Behavior | Log Level |
|---|---|---|
| {tool} not installed | {fallback} | WARNING |
| {tool} unreachable | {fallback} | WARNING |
| Invalid credentials | {fallback} | ERROR |
Testing
# tests/unit/test_{tool_snake}.py
{test_code}
Verification Checklist
- Dependency added to pyproject.toml
- Config fields added with sensible defaults
- Graceful degradation tested (service down)
- Unit tests pass (
tox -e unit) - No new linting errors (
tox -e lint)