Skip to content

[v2] Link targets for the "AuthInfo" interface are improper #3012

Open

Description

@mikecat

What happened?

In the API Reference, links that represents the AuthInfo interface are targeting to authInfo used in InMemoryTransport.onmessage.

An example of a link that looks improper (used in HandleRequestOptions:

Image

The link target that looks improper:

Image

What did you expect?

The links should target at the definition of the interface AuthInfo:

https://ts.sdk.modelcontextprotocol.io/v2/api/index/@modelcontextprotocol/server/#authinfo-2
Image

Instead of part of the definition of InMemoryTransport:

https://ts.sdk.modelcontextprotocol.io/v2/api/index/@modelcontextprotocol/server/#authinfo

Moreover, using numbers to avoid collision looks instable: I think the number may change when another API that uses authInfo is added and then links to AuthInfo may break again.
It may be better to introduce more stable collision-avoiding system like using, for example, #authinfo for the interface and #inmemorytransport-authinfo for the definition of member function.

Code to reproduce

Search for "AuthInfo" using the search box on the documentation page.
Most of the results have the affected AuthInfo link.

SDK version

No response

Area

Documentation

Activity

  1. added
    v2Ideas, requests and plans for v2 of the SDK which will incorporate major changes and fixes
    on Oct 13, 2026
  2. karaaslanz commented on Oct 14, 2026

    @karaaslanz

    I reproduced this against current main (9bc40e9): the generated API index contains earlier authInfo? headings and later ### AuthInfo, while cross-file AuthInfo type links target #authinfo (the earlier heading).

    I am working on a narrowly scoped docs fix: a stable TypeDoc HTML anchor for the interface and a targeted VitePress rewrite for the affected cross-file type links, preserving links to authInfo properties. I will verify the emitted Markdown and rendered HTML before opening a PR, and keep the separate Windows glob issue #3015 / #3016 out of scope.

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    v2Ideas, requests and plans for v2 of the SDK which will incorporate major changes and fixes

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions