How long does the integration take?

Change one base URL in an OpenAI-compatible client, or install the Python or TypeScript SDK; the quickstart routes a first request in a few minutes.

Will this lock us into another vendor?

No. The router is Apache-2.0 open source, your provider keys stay yours, and the API is OpenAI-compatible, so leaving is a change of base URL.

What happens when a provider fails?

The router falls back to the next model your policy allows and records the fallback in the trace, so an outage costs a retry, not an incident.

check-docs - Prompt - OpenSmartRoute

Name: check-docs
Author: mgiovani

Prompt file imported from mgiovani/ai-cursor-init (.cursor/commands/cursor-init/check-docs.md). Fill in {{PLACEHOLDER}}, {{COMPONENT_NAME}} before use. Copyright stays with the author.

Check Documentation Quality

Validate documentation freshness, completeness, and quality against current codebase state.

What This Does

Performs a comprehensive analysis of your documentation to identify:

Missing Documentation: Relevant documentation types that should exist but don't
Stale Documentation: Docs that are out of sync with current codebase
Quality Issues: Formatting problems, broken links, missing sections
Coverage Gaps: Undocumented components, APIs, or features
Configuration Compliance: Documentation status relative to .cursor-init.yaml settings

Validation Checks

Relevance Check

Determines which documentation types are relevant to your project
Identifies missing documentation for detected technologies
Example: If database models found, checks for data-model.md

Freshness Check

Compares documentation last-modified dates with related code changes
Identifies docs that haven't been updated after significant code changes
Suggests which docs need updating

Completeness Check

Verifies all required sections are present in documentation
Checks for placeholder text ({{PLACEHOLDER}}) that wasn't replaced
Ensures diagrams are properly rendered

Quality Check

Validates Mermaid diagram syntax
Checks for broken internal links
Verifies markdown formatting
Ensures consistent style across documents

Configuration Check

Confirms documentation aligns with .cursor-init.yaml settings
Identifies files that exist but are disabled in config
Suggests configuration updates if needed

Usage

Basic validation:

/check-docs

With specific focus:

/check-docs focus on data documentation

Quick check:

/check-docs quick

Output Format

Status Summary

Documentation Health Report

Overall Score: 85/100

✅ Good:
- docs/architecture.md (up to date, well-structured)
- docs/onboarding.md (comprehensive, current)
- docs/adr/ (5 records, all current)

⚠️ Needs Attention:
- docs/data-model.md (outdated - models changed 5 days ago)
  → Recommendation: Run /gen-er-diagram

- docs/deployment.md (missing deployment steps for new services)
  → Recommendation: Run /sync-doc deployment

❌ Missing:
- docs/api-documentation.md (API endpoints detected but not documented)
  → Recommendation: Enable in .cursor-init.yaml and run /init-docs

🔧 Quality Issues:
- docs/architecture.md: Contains unreplaced placeholder {{COMPONENT_NAME}}
- docs/data-model.md: Mermaid diagram syntax error on line 42

Detailed Report

For each documentation file, provides:

Last Updated: Timestamp of last modification
Relevance: Whether still relevant to project
Freshness: How current it is relative to codebase
Quality Score: Based on completeness and formatting
Specific Issues: Line numbers for problems
Recommendations: Actionable next steps

Configuration

Respects .cursor-init.yaml settings:

documentation:
  core: { architecture: true, onboarding: true, adr: true }
  data: { data_model: true, database_ops: false }

generation:
  include_code_examples: true
  include_diagrams: true
  auto_generate_toc: true

Only checks documentation types that are:

Relevant to the project (based on detected technologies)
Not explicitly disabled in configuration

Validation Criteria

Freshness Scoring

Fresh (90-100): Updated within last 7 days or no code changes
Good (70-89): Minor code changes since last update
Stale (50-69): Significant code changes since last update
Outdated (<50): Major code changes or very old

Completeness Scoring

Complete (90-100): All sections present, no placeholders
Good (70-89): Most sections present, minor gaps
Incomplete (50-69): Several missing sections
Poor (<50): Major sections missing

Quality Scoring

Excellent (90-100): No formatting issues, all diagrams valid
Good (70-89): Minor formatting issues
Fair (50-69): Several formatting or syntax issues
Poor (<50): Major problems, broken diagrams

Process

I will:

Read .cursor-init.yaml to understand documentation preferences
Scan docs/ directory for existing documentation files
Analyze project to determine relevant documentation types
Check each relevant documentation file for:
- Existence (is it missing?)
- Freshness (is it outdated?)
- Completeness (are sections missing?)
- Quality (formatting, diagrams, links)
Generate comprehensive health report
Provide prioritized recommendations

Actionable Recommendations

Based on findings, I'll suggest specific commands:

/gen-er-diagram - For outdated database documentation
/sync-doc [name] - For specific outdated documentation
/sync-category [category] - For outdated category
/sync-docs - For comprehensive update
/init-docs - For missing documentation

Template Location: .cursor/cursor-init/templates/ Configuration File: .cursor-init.yaml (optional)

Install check-docs and it becomes one more candidate the router can pick - when it fits.

A listing is a routing target with a manifest: what it does, which domains it covers, what it costs and who publishes it. Once installed it sits beside your own models and tools, is scored like any other candidate for each request, and shows up in the trace when it wins. Ratings come from workspaces that installed it, one per account.

# Check Documentation Quality Validate documentation freshness, completeness, and quality against current codebase state. ## What This Does Performs a comprehensive analysis of your documentation to identify: 1. **Missing Documentation**: Relevant documentation types that should exist but don't 2. **Stale Documentation**: Docs that are out of sync with current codebase 3. **Quality Issues**: Formatting problems, broken links, missing sections 4. **Coverage Gaps**: Undocumented components, APIs, or features 5. **Configuration Compliance**: Documentation status relative to `.cursor-init.yaml` settings ## Validation Checks ### Relevance Check - Determines which documentation types are relevant to your project - Identifies missing documentation for detected technologies - Example: If database models found, checks for data-model.md ### Freshness Check - Compares documentation last-modified dates with related code changes - Identifies docs that haven't been updated after significant code changes - Suggests which docs need updating ### Completeness Check - Verifies all required sections are present in documentation - Checks for placeholder text ({{PLACEHOLDER}}) that wasn't replaced - Ensures diagrams are properly rendered ### Quality Check - Validates Mermaid diagram syntax - Checks for broken internal links - Verifies markdown formatting - Ensures consistent style across documents ### Configuration Check - Confirms documentation aligns with `.cursor-init.yaml` settings - Identifies files that exist but are disabled in config - Suggests configuration updates if needed ## Usage Basic validation: ``` /check-docs ``` With specific focus: ``` /check-docs focus on data documentation ``` Quick check: ``` /check-docs quick ``` ## Output Format ### Status Summary ``` Documentation Health Report Overall Score: 85/100 ✅ Good: - docs/architecture.md (up to date, well-structured) - docs/onboarding.md (comprehensive, current) - docs/adr/ (5 records, all current) ⚠️ Needs Attention: - docs/data-model.md (outdated - models changed 5 days ago) → Recommendation: Run /gen-er-diagram - docs/deployment.md (missing deployment steps for new services) → Recommendation: Run /sync-doc deployment ❌ Missing: - docs/api-documentation.md (API endpoints detected but not documented) → Recommendation: Enable in .cursor-init.yaml and run /init-docs 🔧 Quality Issues: - docs/architecture.md: Contains unreplaced placeholder {{COMPONENT_NAME}} - docs/data-model.md: Mermaid diagram syntax error on line 42 ``` ### Detailed Report For each documentation file, provides: - **Last Updated**: Timestamp of last modification - **Relevance**: Whether still relevant to project - **Freshness**: How current it is relative to codebase - **Quality Score**: Based on completeness and formatting - **Specific Issues**: Line numbers for problems - **Recommendations**: Actionable next steps ## Configuration Respects `.cursor-init.yaml` settings: ```yaml documentation: core: { architecture: true, onboarding: true, adr: true } data: { data_model: true, database_ops: false } generation: include_code_examples: true include_diagrams: true auto_generate_toc: true ``` Only checks documentation types that are: - Relevant to the project (based on detected technologies) - Not explicitly disabled in configuration ## Validation Criteria ### Freshness Scoring - **Fresh (90-100)**: Updated within last 7 days or no code changes - **Good (70-89)**: Minor code changes since last update - **Stale (50-69)**: Significant code changes since last update - **Outdated (<50)**: Major code changes or very old ### Completeness Scoring - **Complete (90-100)**: All sections present, no placeholders - **Good (70-89)**: Most sections present, minor gaps - **Incomplete (50-69)**: Several missing sections - **Poor (<50)**: Major sections missing ### Quality Scoring - **Excellent (90-100)**: No formatting issues, all diagrams valid - **Good (70-89)**: Minor formatting issues - **Fair (50-69)**: Several formatting or syntax issues - **Poor (<50)**: Major problems, broken diagrams ## Process I will: 1. Read `.cursor-init.yaml` to understand documentation preferences 2. Scan `docs/` directory for existing documentation files 3. Analyze project to determine relevant documentation types 4. Check each relevant documentation file for: - Existence (is it missing?) - Freshness (is it outdated?) - Completeness (are sections missing?) - Quality (formatting, diagrams, links) 5. Generate comprehensive health report 6. Provide prioritized recommendations ## Actionable Recommendations Based on findings, I'll suggest specific commands: - `/gen-er-diagram` - For outdated database documentation - `/sync-doc [name]` - For specific outdated documentation - `/sync-category [category]` - For outdated category - `/sync-docs` - For comprehensive update - `/init-docs` - For missing documentation --- **Template Location**: `.cursor/cursor-init/templates/` **Configuration File**: `.cursor-init.yaml` (optional)

{ "prompt": "# Check Documentation Quality\n\nValidate documentation freshness, completeness, and quality against current codebase state.\n\n## What This Does\n\nPerforms a comprehensive analysis of your documentation to identify:\n\n1. **Missing Documentation**: Relevant documentation types that should exist but don't\n2. **Stale Documentation**: Docs that are out of sync with current codebase\n3. **Quality Issues**: Formatting problems, broken links, missing sections\n4. **Coverage Gaps**: Undocumented components, APIs, or features\n5. **Configuration Compliance**: Documentation status relative to `.cursor-init.yaml` settings\n\n## Validation Checks\n\n### Relevance Check\n- Determines which documentation types are relevant to your project\n- Identifies missing documentation for detected technologies\n- Example: If database models found, checks for data-model.md\n\n### Freshness Check\n- Compares documentation last-modified dates with related code changes\n- Identifies docs that haven't been updated after significant code changes\n- Suggests which docs need updating\n\n### Completeness Check\n- Verifies all required sections are present in documentation\n- Checks for placeholder text ({{PLACEHOLDER}}) that wasn't replaced\n- Ensures diagrams are properly rendered\n\n### Quality Check\n- Validates Mermaid diagram syntax\n- Checks for broken internal links\n- Verifies markdown formatting\n- Ensures consistent style across documents\n\n### Configuration Check\n- Confirms documentation aligns with `.cursor-init.yaml` settings\n- Identifies files that exist but are disabled in config\n- Suggests configuration updates if needed\n\n## Usage\n\nBasic validation:\n```\n/check-docs\n```\n\nWith specific focus:\n```\n/check-docs focus on data documentation\n```\n\nQuick check:\n```\n/check-docs quick\n```\n\n## Output Format\n\n### Status Summary\n```\nDocumentation Health Report\n\nOverall Score: 85/100\n\n✅ Good:\n- docs/architecture.md (up to date, well-structured)\n- docs/onboarding.md (comprehensive, current)\n- docs/adr/ (5 records, all current)\n\n⚠️ Needs Attention:\n- docs/data-model.md (outdated - models changed 5 days ago)\n → Recommendation: Run /gen-er-diagram\n\n- docs/deployment.md (missing deployment steps for new services)\n → Recommendation: Run /sync-doc deployment\n\n❌ Missing:\n- docs/api-documentation.md (API endpoints detected but not documented)\n → Recommendation: Enable in .cursor-init.yaml and run /init-docs\n\n🔧 Quality Issues:\n- docs/architecture.md: Contains unreplaced placeholder {{COMPONENT_NAME}}\n- docs/data-model.md: Mermaid diagram syntax error on line 42\n```\n\n### Detailed Report\n\nFor each documentation file, provides:\n- **Last Updated**: Timestamp of last modification\n- **Relevance**: Whether still relevant to project\n- **Freshness**: How current it is relative to codebase\n- **Quality Score**: Based on completeness and formatting\n- **Specific Issues**: Line numbers for problems\n- **Recommendations**: Actionable next steps\n\n## Configuration\n\nRespects `.cursor-init.yaml` settings:\n\n```yaml\ndocumentation:\n core: { architecture: true, onboarding: true, adr: true }\n data: { data_model: true, database_ops: false }\n\ngeneration:\n include_code_examples: true\n include_diagrams: true\n auto_generate_toc: true\n```\n\nOnly checks documentation types that are:\n- Relevant to the project (based on detected technologies)\n- Not explicitly disabled in configuration\n\n## Validation Criteria\n\n### Freshness Scoring\n- **Fresh (90-100)**: Updated within last 7 days or no code changes\n- **Good (70-89)**: Minor code changes since last update\n- **Stale (50-69)**: Significant code changes since last update\n- **Outdated (<50)**: Major code changes or very old\n\n### Completeness Scoring\n- **Complete (90-100)**: All sections present, no placeholders\n- **Good (70-89)**: Most sections present, minor gaps\n- **Incomplete (50-69)**: Several missing sections\n- **Poor (<50)**: Major sections missing\n\n### Quality Scoring\n- **Excellent (90-100)**: No formatting issues, all diagrams valid\n- **Good (70-89)**: Minor formatting issues\n- **Fair (50-69)**: Several formatting or syntax issues\n- **Poor (<50)**: Major problems, broken diagrams\n\n## Process\n\nI will:\n1. Read `.cursor-init.yaml` to understand documentation preferences\n2. Scan `docs/` directory for existing documentation files\n3. Analyze project to determine relevant documentation types\n4. Check each relevant documentation file for:\n - Existence (is it missing?)\n - Freshness (is it outdated?)\n - Completeness (are sections missing?)\n - Quality (formatting, diagrams, links)\n5. Generate comprehensive health report\n6. Provide prioritized recommendations\n\n## Actionable Recommendations\n\nBased on findings, I'll suggest specific commands:\n- `/gen-er-diagram` - For outdated database documentation\n- `/sync-doc [name]` - For specific outdated documentation\n- `/sync-category [category]` - For outdated category\n- `/sync-docs` - For comprehensive update\n- `/init-docs` - For missing documentation\n\n---\n\n**Template Location**: `.cursor/cursor-init/templates/`\n**Configuration File**: `.cursor-init.yaml` (optional)", "variables": [ "PLACEHOLDER", "COMPONENT_NAME" ], "notes": "Validate documentation freshness, completeness, and quality against current codebase state.", "metadata": { "source": { "provider": "github-cursor-commands", "repository": "https://github.com/mgiovani/ai-cursor-init", "path": ".cursor/commands/cursor-init/check-docs.md", "ref": "fc15400e4baab4607f408f5b83fed19263e564e3", "url": "https://github.com/mgiovani/ai-cursor-init/blob/fc15400e4baab4607f408f5b83fed19263e564e3/.cursor/commands/cursor-init/check-docs.md", "key": "mgiovani/ai-cursor-init/.cursor/commands/cursor-init/check-docs.md" } } }

check-docs

About