Skip to content

[Code Quality] Document MCP domain pattern requirements in reference docs #14460

Closed as not planned

Description

@github-actions

Description

The MCP Gateway configuration requires domains to follow a specific DNS hostname pattern (regex: ^[a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?(\\.[a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?)*$), but this requirement is completely undocumented in the user-facing documentation.

Users encounter validation errors without understanding the format requirements, leading to frustration and support requests.

Suggested Changes

Add a "Domain Format Requirements" section to docs/src/content/docs/reference/mcp-gateway.md:

### Domain Format Requirements

MCP Gateway domains must be valid DNS hostnames following these rules:

- Start and end with alphanumeric characters (a-z, A-Z, 0-9)
- May contain hyphens (-) in the middle
- Each label (part between dots) must be 1-63 characters
- No consecutive dots or trailing dots
- No underscores or other special characters

**Valid Examples:**
- `api.example.com`
- `localhost`
- `mcp-server.internal`
- `my-service.company.io`

**Invalid Examples:**
- `-invalid.com` (starts with hyphen)
- `domain..com` (consecutive dots)
- `under_score.com` (contains underscore)
- `trailing-hyphen-.com` (ends with hyphen)

Files Affected

  • docs/src/content/docs/reference/mcp-gateway.md

Success Criteria

  • Domain pattern requirements documented with clear examples
  • Valid and invalid examples provided
  • No changes to validation logic needed (already enforced in schema)
  • Users can self-diagnose domain format errors

Source

Extracted from Schema Consistency Audit discussion #14299

Finding: "Undocumented Pattern: MCP Domain Validation" - Schema defines strict DNS hostname pattern but reference documentation doesn't explain format requirements.

Priority

High - Users encounter validation errors without clear guidance on how to fix them. Reduces support burden and improves user experience.

AI generated by Discussion Task Miner - Code Quality Improvement Agent

  • expires on Feb 9, 2026, 5:26 AM UTC

Activity

  1. github-actions commented on Feb 8, 2026

    @github-actions
    ContributorAuthor

    🍪 Issue Monster has assigned this to Copilot!

    I've identified this issue as a good candidate for automated resolution and assigned it to the Copilot agent.

    The Copilot agent will analyze the issue and create a pull request with the fix.

    Om nom nom! 🍪

    AI generated by Issue Monster

  2. github-actions commented on Feb 9, 2026

    @github-actions
    ContributorAuthor

    This issue was automatically closed because it expired on 2026-02-09T05:26:24.181Z.

    Closed by Workflow

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

Metadata

Metadata

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions