Skip to content

Conversation

@maxisbey
Copy link
Contributor

Two type aliases were referenced in the schema reference documentation but not documented because they were missing the @category JSDoc tag, causing broken anchor links.

Motivation and Context

JSONRPCResponse and SamplingMessageContentBlock are referenced in the schema docs with hyperlinks, but clicking them leads to broken anchors because the types weren't rendered. The typedoc plugin uses @category tags to determine which types to include in each section.

Fixes #1982

How Has This Been Tested?

  • Ran npm run check:schema - all checks pass
  • Verified both types now appear in docs/specification/draft/schema.mdx with ### \JSONRPCResponse`and### `SamplingMessageContentBlock`` headings

Breaking Changes

None

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update

Checklist

  • I have read the MCP Documentation
  • My code follows the repository's style guidelines
  • New and existing tests pass locally
  • I have added appropriate error handling
  • I have added or updated documentation as needed

Additional context

AI Disclaimer

…ingMessageContentBlock

These two type aliases were referenced in the schema reference documentation but
not documented because they were missing the @category JSDoc tag.

- Add `@category JSON-RPC` to JSONRPCResponse
- Add `@category `sampling/createMessage`` to SamplingMessageContentBlock

Fixes #1982
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.

Schema docs: JSONRPCResponse and SamplingMessageContentBlock missing from documentation

3 participants