add-provider

Add a New LLM Provider to OhMyCode

Connect a new LLM backend (e.g., Gemini, Ollama, DeepSeek, local models).

When to Use

• User says "add a provider", "connect to Gemini", "support Ollama"
• User wants to use a model from a new API that isn't OpenAI-compatible

Prerequisites

• Read docs/DEVELOPMENT_GUIDE.md
• Read ohmycode/providers/base.py to understand Provider Protocol, register_provider()
• Read ohmycode/core/messages.py for TextChunk, ToolCallStart, TurnComplete, TokenUsage
• Look at ohmycode/providers/openai.py as reference

Step-by-Step Guide

Step 1: Understand the Provider Protocol

Every provider must implement one method:

async def stream(
    self,
    messages: list[Message],
    tools: list[ToolDef],
    system: str,
    model: str,
    **kwargs,
) -> AsyncIterator[StreamEvent]:

It must yield these events in order:

1. TextChunk(text="...") — for each streamed text token
2. ToolCallStart(tool_name="...", tool_use_id="...", params={...}) — for each tool call
3. TurnComplete(finish_reason="stop"|"tool_use", usage=TokenUsage(...)) — always last

Step 2: Create the Provider File

Copy templates/provider_template.py to ohmycode/providers/<name>.py.

Fill in:

• __init__() — initialize the API client
• stream() — handle the streaming response format of the target API

Step 3: Handle Message Conversion

Different APIs have different message formats. Key conversions:

• UserMessage → the API's user message format
• AssistantMessage (with tool_calls) → the API's assistant + tool use format
• ToolResultMessage → the API's tool result format
• system parameter → some APIs put it in messages, some as a separate param

Step 4: Write Tests

Create tests/providers/test_<name>_provider.py:

import pytest
from ohmycode.providers.base import PROVIDER_REGISTRY

def test_provider_is_registered():
    import ohmycode.providers.<name>
    assert "<name>" in PROVIDER_REGISTRY

def test_provider_instantiation():
    from ohmycode.providers.<name> import <ProviderClass>
    provider = <ProviderClass>(api_key="test")
    assert provider.name == "<name>"