Skip to content

docs(agents): add LLM API provider guide in app/services#1135

Merged
muddlebee merged 2 commits intoTracer-Cloud:mainfrom
muddlebee:docs/services-agents-llm
Apr 30, 2026
Merged

docs(agents): add LLM API provider guide in app/services#1135
muddlebee merged 2 commits intoTracer-Cloud:mainfrom
muddlebee:docs/services-agents-llm

Conversation

@muddlebee
Copy link
Copy Markdown
Collaborator

Fixes #

Describe the changes you have made in this PR -

Adds app/services/AGENTS.md: a short guide for extending API-backed LLM providers (where llm_client.py and LLM_PROVIDER wiring live), with a pointer to CLI work in app/integrations/llm_cli/AGENTS.md and OpenClaw’s provider catalog for discovery.

Single-file change only — no sample templates, no code paths.

Demo/Screenshot for feature changes and bug fixes -

Documentation-only. No UI. Proof: review app/services/AGENTS.md (37 lines).


Code Understanding and AI Usage

Did you use AI assistance (ChatGPT, Claude, Copilot, etc.) to write any part of this code?

  • No, I wrote all the code myself
  • Yes, I used AI assistance (continue below)

If you used AI assistance:

  • I have reviewed every single line of the AI-generated code
  • I can explain the purpose and logic of each function/component I added
  • I have tested edge cases and understand how the code handles them
  • I have modified the AI output to follow this project's coding standards and conventions

Explain your implementation approach:

Adds one Markdown file next to llm_client.py so agents/contributors know which files to touch for new HTTP LLM providers and how that differs from subprocess CLI providers.


Checklist before requesting a review

  • I have added proper PR title and linked to the issue
  • I have performed a self-review of my code
  • I can explain the purpose of every function, class, and logic block I added
  • I understand why my changes work and have tested them thoroughly
  • I have considered potential edge cases and how my code handles them
  • If it is a core feature, I have added thorough tests
  • My code follows the project's style guidelines and conventions

Note: Please check Allow edits from maintainers if you would like us to assist in the PR.

@muddlebee muddlebee marked this pull request as ready for review April 30, 2026 11:39
@muddlebee muddlebee merged commit 6f5d378 into Tracer-Cloud:main Apr 30, 2026
8 checks passed
@github-actions
Copy link
Copy Markdown
Contributor

🤖 CI passed. Linter didn't scream. Reviewer typed LGTM. @muddlebee, every machine in this pipeline just slow-clapped. 🖥️✨


👋 Join us on Discord - OpenSRE : hang out, contribute, or hunt for features and issues. Everyone's welcome.

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented Apr 30, 2026

Greptile Summary

This PR adds app/services/AGENTS.md, a developer guide for wiring new API-backed LLM providers, and updates the root AGENTS.md with a cross-reference. The file references (llm_client.py, app/config.py, app/cli/wizard/config.py, app/cli/wizard/env_sync.py) and the step-by-step instructions are accurate against the current codebase.

  • The guide cites https://docs.openclaw.ai/providers as the "Primary reference for provider discovery," but OpenClaw is an unrelated personal-AI-assistant product (WhatsApp/Telegram inbox and calendar management). This link should be removed or replaced with a reference that is actually relevant to this project (e.g., an internal doc, the LiteLLM/LangChain provider list, or simply omitted).

Confidence Score: 4/5

Safe to merge after fixing or removing the misleading external link in app/services/AGENTS.md.

A single P1 issue exists: the "primary reference" URL points to an unrelated product, which would actively mislead contributors following this guide. All file references and steps are otherwise correct. No code paths are affected.

app/services/AGENTS.md — the docs.openclaw.ai link on line 9 needs to be removed or replaced.

Important Files Changed

Filename Overview
app/services/AGENTS.md New contributor guide for LLM API providers — file references and step-by-step instructions are accurate, but the "primary reference" link (docs.openclaw.ai/providers) points to an unrelated personal-AI-assistant product and should be removed or replaced.
AGENTS.md Root AGENTS.md updated to add a cross-reference to the new app/services/AGENTS.md; change is minimal and accurate.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Developer adding a new LLM provider] --> B{Provider type?}
    B -->|API / HTTP| C[app/services/AGENTS.md]
    B -->|Subprocess CLI| D[app/integrations/llm_cli/AGENTS.md]
    C --> E[app/config.py\nLLMProvider literal + env vars]
    C --> F[app/cli/wizard/config.py\nSUPPORTED_PROVIDERS metadata]
    C --> G[app/services/llm_client.py\nLLM_PROVIDER → client routing]
    C --> H[app/cli/wizard/env_sync.py\n.env key sync]
    E & F & G & H --> I[tests/services/ + wizard tests]
Loading

Reviews (1): Last reviewed commit: "docs(agents): cross-link LLM API guide f..." | Re-trigger Greptile

Comment thread app/services/AGENTS.md

Primary reference for provider discovery:

- [https://docs.openclaw.ai/providers](https://docs.openclaw.ai/providers)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Unrelated external link cited as primary reference

docs.openclaw.ai is the documentation site for OpenClaw, a personal AI assistant product (inbox clearing, email sending, calendar management via WhatsApp/Telegram). It is not affiliated with this project. Pointing contributors to an unrelated product's provider catalog as the "Primary reference for provider discovery" is misleading — a developer following this guide would land on documentation that has nothing to do with opensre's provider wiring.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant