Skip to content

Commit 6ec1f9c

Browse files
travisbreaksclaude
andcommitted
fix: replace cross-package {@linkcode} refs with backtick code in JSDoc
TypeDoc cannot resolve {@linkcode Client} and {@linkcode Server} from the core package because those classes live in separate packages (@modelcontextprotocol/client and @modelcontextprotocol/server). Replace with backtick-quoted code spans so the docs build passes without warnings. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 2a6dc38 commit 6ec1f9c

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

packages/core/src/shared/protocol.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ export type ProtocolOptions = {
9797
/**
9898
* Interval (in milliseconds) between periodic ping requests sent to the remote side
9999
* to verify connection health. When set, pings begin after initialization completes
100-
* ({@linkcode Client} starts them after the MCP handshake; {@linkcode Server} starts
100+
* (`Client` starts them after the MCP handshake; `Server` starts
101101
* them on `notifications/initialized`) and stop automatically when the connection closes.
102102
*
103103
* Per the MCP specification, implementations SHOULD periodically issue pings to
@@ -760,8 +760,8 @@ export abstract class Protocol<ContextT extends BaseContext> {
760760
* stop the loop; pings continue until the connection is closed.
761761
*
762762
* This is not called automatically by the base {@linkcode Protocol.connect | connect()}
763-
* method. {@linkcode Client} calls it after the MCP initialization handshake
764-
* (and on reconnection), and {@linkcode Server} calls it when the
763+
* method. `Client` calls it after the MCP initialization handshake
764+
* (and on reconnection), and `Server` calls it when the
765765
* `notifications/initialized` notification is received. Custom `Protocol`
766766
* subclasses must call this explicitly after their own initialization.
767767
*

0 commit comments

Comments
 (0)