Skip to content

Add JSDoc descriptions and @example blocks to Client public methods#1556

Merged
jonathanhefner merged 2 commits intomodelcontextprotocol:mainfrom
jonathanhefner:add-client-api-docs
Feb 20, 2026
Merged

Add JSDoc descriptions and @example blocks to Client public methods#1556
jonathanhefner merged 2 commits intomodelcontextprotocol:mainfrom
jonathanhefner:add-client-api-docs

Conversation

@jonathanhefner
Copy link
Member

Add JSDoc to the 12 previously-undocumented public methods on Client, and type-checked @example blocks to the most important ones (callTool, connect, setRequestHandler, listTools, listPrompts, listResources).

@jonathanhefner jonathanhefner requested a review from a team as a code owner February 18, 2026 23:55
@changeset-bot
Copy link

changeset-bot bot commented Feb 18, 2026

⚠️ No Changeset found

Latest commit: 4e5a56f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@pkg-pr-new
Copy link

pkg-pr-new bot commented Feb 18, 2026

Open in StackBlitz

@modelcontextprotocol/client

npm i https://pkg.pr.new/modelcontextprotocol/typescript-sdk/@modelcontextprotocol/client@1556

@modelcontextprotocol/server

npm i https://pkg.pr.new/modelcontextprotocol/typescript-sdk/@modelcontextprotocol/server@1556

@modelcontextprotocol/express

npm i https://pkg.pr.new/modelcontextprotocol/typescript-sdk/@modelcontextprotocol/express@1556

@modelcontextprotocol/hono

npm i https://pkg.pr.new/modelcontextprotocol/typescript-sdk/@modelcontextprotocol/hono@1556

@modelcontextprotocol/node

npm i https://pkg.pr.new/modelcontextprotocol/typescript-sdk/@modelcontextprotocol/node@1556

commit: 4e5a56f

Add JSDoc to the 12 previously-undocumented public methods on `Client`,
and type-checked `@example` blocks to the most important ones
(`callTool`, `connect`, `setRequestHandler`, `listTools`, `listPrompts`,
`listResources`).

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@jonathanhefner jonathanhefner enabled auto-merge (squash) February 19, 2026 02:41
@jonathanhefner jonathanhefner merged commit 1c4c77a into modelcontextprotocol:main Feb 20, 2026
10 of 11 checks passed
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

Successfully merging this pull request may close these issues.

2 participants