Skip to content

[Docs] Add provider qualification checklist #3371

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
roomote-roomote wants to merge 1 commit into
base: develop
Choose a base branch
from
Draft

[Docs] Add provider qualification checklist #3371

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions apps/docs/providers/inference/openai-compatible.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,36 @@ do not need direct network access to the endpoint or the API key.
4. start a small Roomote task and confirm it completes through the endpoint
5. check the upstream server logs for the request

## Qualify a provider or gateway

Provider maintainers and gateway operators can use the generic connection before
requesting provider-specific support. A useful compatibility report covers the
same path a Roomote task uses:

1. Confirm `GET /v1/models` returns stable model IDs with the configured bearer
credential, and that a missing or invalid credential is rejected.

@roomote-community roomote-community Bot Oct 2, 2026

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.

This makes authentication rejection a requirement for every qualifying endpoint, but this same guide explicitly supports endpoints without an API key (including local servers). Those endpoints cannot reject a missing credential, so they are incorrectly excluded from the checklist. Scope this assertion to endpoints configured to require bearer auth, and allow keyless endpoints to report that authentication is not applicable.

2. Run a short non-streaming chat completion and a streaming completion that
terminates cleanly.
3. Run a Roomote task that asks the model to call a harmless read-only tool,
accepts the matching tool result, and then produces a final text response.
4. Repeat the tool task with enough prior messages to confirm the endpoint keeps
tool-call IDs and message roles intact across the round trip.
5. Record the endpoint version, tested model IDs, supported reasoning values,
context and output limits, image support, error behavior for `401`, `429`,
and `5xx` responses, and any unsupported OpenAI fields.

Do not include API keys, prompts from real repositories, or other private data in
the report. Synthetic tasks are sufficient. A passing report establishes
OpenAI-compatible behavior; it does not imply that Roomote endorses the provider
or will add a dedicated catalog entry.

To request a compatibility review or provider-specific setup guide, open a
[well-scoped GitHub issue](https://github.com/RooCodeInc/Roomote/issues/new/choose)
with the report and links to the provider-owned API and data-handling
documentation. Follow Roomote's
[contribution policy](https://github.com/RooCodeInc/Roomote/blob/develop/CONTRIBUTING.md)
instead of opening an unsolicited pull request.

## Common issues

- **No models appear.** Confirm the endpoint URL includes the OpenAI `/v1` API
Expand Down
Loading