response-compliance

Runs the official OpenResponses compliance test suite against Response API endpoints.

74|11|Updated Jul 4, 2024
One-click install
npx skills add https://github.com/OpenSourceAGI/qwksearch-research-agent --skill response-compliance-opensourceagi
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: response-compliance
Source: https://github.com/OpenSourceAGI/qwksearch-research-agent/tree/main/apps/qwk-in-lobe/.agents/skills/response-compliance
Command: npx skills add https://github.com/OpenSourceAGI/qwksearch-research-agent --skill response-compliance-opensourceagi

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Verifying that a Response API implementation conforms to the OpenResponses specification requires running many structured endpoint tests manually, which is slow and error-prone. This Skill automates compliance testing against local or remote Response API endpoints. ## Core Features & Use Cases - Compliance Test Execution: Runs the official openresponses/openresponses CLI test suite against a target endpoint with a single command. - Flexible Auth Modes: Supports dev mock-user headers, API key authentication, and custom auth header configurations. - Targeted Filtering & Output: Filters specific test IDs (basic-response, streaming-response, tool-calling, etc.) and supports verbose or JSON output for CI pipelines. - Use Case: After implementing the api/v1/responses route in LobeHub, run the compliance suite with --filter streaming-response -v to debug SSE event lifecycle issues before merging. ## Quick Start Run the OpenResponses compliance tests against my local dev server at localhost:3010 using the dev auth header and show verbose output for any failures.

Frequently Asked Questions about response-compliance

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I run OpenResponses compliance tests against a local API?

Run the compliance test script with APP_URL pointing to your server, for example APP_URL=http://localhost:3010 bun run test:response-compliance with the appropriate auth flags. The script clones the official openresponses repo and runs its CLI test runner.

How to test only specific Response API endpoints like streaming?

Use the --filter flag with test IDs such as streaming-response, basic-response, tool-calling, or multi-turn. Multiple IDs can be comma-separated to run a targeted subset of the compliance suite.

What authentication modes does the compliance test support?

Three modes are supported: dev mode with a mock user header and --no-bearer flag, standard API key authentication via --api-key, and fully custom auth header name/value pairs for other setups.

Why does the compliance test fail with 'Failed to parse JSON'?

This error means authentication failed and the server returned an HTML redirect instead of JSON. Verify your auth flags are correct and that the dev server has ENABLE_MOCK_DEV_USER=true set in the environment.

Can compliance test output be used in CI pipelines?

Yes, pass the --json flag to emit structured JSON output suitable for CI consumption. Combine it with --filter to run only the test IDs relevant to your pipeline stage.