Skip to content
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.

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

Feature Request: URL handling in documentation #778

Open
witchof0x20 opened this issue Feb 21, 2025 · 0 comments
Open

Feature Request: URL handling in documentation #778

witchof0x20 opened this issue Feb 21, 2025 · 0 comments

Comments

@witchof0x20
Copy link

Super niche issue, but I ran into this while parsing the MCP schema.

warning: this URL is not a hyperlink
    --> .../target/debug/build/mcp-58ca0a9bf43df898/out/schema.rs:3319:1
     |
3319 | https://datatracker.ietf.org/doc/html/rfc5424#section-6.2.1*/
     | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
     |
     = note: bare URLs are not automatically turned into clickable links
help: use an automatic link instead
     |
3319 | <https://datatracker.ietf.org/doc/html/rfc5424#section-6.2.1>*/

relevant schema line: https://github.com/modelcontextprotocol/specification/blob/main/schema/2024-11-05/schema.json#L1061

This could end up overly complex if "does this description contain a URL" is harder than one would expect, but it would be nice to wrap urls in <> when encountered to avoid the doc bug and produce better docs.

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

No branches or pull requests

1 participant