Skip to content

[pull] main from modelcontextprotocol:main #20

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

Merged
merged 2 commits into from
Mar 26, 2025

Conversation

pull[bot]
Copy link

@pull pull bot commented Mar 26, 2025

See Commits and Changes for more details.


Created by pull[bot] (v2.0.0-alpha.1)

Can you help keep this open source service alive? 💖 Please sponsor : )

Summary by Sourcery

Enhance type annotations and generics for Model Context Protocol (MCP) types and improve type safety across various components

New Features:

  • Add support for more flexible type parameters in request and notification classes
  • Introduce more comprehensive type hints for server context and lifespan management

Enhancements:

  • Refactor type annotations for requests, notifications, and generic types to provide more precise type information
  • Improve type safety for context and lifespan management in FastMCP server

Tests:

  • Add a new test case demonstrating type-safe context and lifespan management

Chores:

  • Simplify some assertion and error handling code
  • Remove explicit type exclusions in ruff configuration

@pull pull bot added the ⤵️ pull label Mar 26, 2025
@pull pull bot merged commit 9a2bb6a into Stars1233:main Mar 26, 2025
Copy link

gitstream-cm bot commented Mar 26, 2025

🚨 gitStream Monthly Automation Limit Reached 🚨

Your organization has exceeded the number of pull requests allowed for automation with gitStream.
Monthly PRs automated: 5033/250

To continue automating your PR workflows and unlock additional features, please contact LinearB.

Copy link

sourcery-ai bot commented Mar 26, 2025

Reviewer's Guide by Sourcery

This pull request introduces several type hint improvements to the mcp module, enhancing code clarity and maintainability. It also addresses a type error issue related to lifespan context by adding a new test case. Additionally, it includes minor changes to assertion messages and updates to generic type parameters.

Updated class diagram for Request and Notification

classDiagram
    class Request~RequestParamsT, MethodT~ {
        <<Abstract>>
        jsonrpc: Literal[\'2.0\']
        id: RequestId
        method: MethodT
        params: RequestParamsT
    }
    class Notification~NotificationParamsT, MethodT~ {
        <<Abstract>>
        jsonrpc: Literal[\'2.0\']
        method: MethodT
        params: NotificationParamsT
    }

    Request --|> JSONRPCRequest : Inherits
    Request --|> InitializeRequest : Inherits
    Request --|> PingRequest : Inherits
    Request --|> ListResourcesRequest : Inherits
    Request --|> ListResourceTemplatesRequest : Inherits
    Request --|> ReadResourceRequest : Inherits
    Request --|> SubscribeRequest : Inherits
    Request --|> UnsubscribeRequest : Inherits
    Request --|> ListPromptsRequest : Inherits
    Request --|> GetPromptRequest : Inherits
    Request --|> ListToolsRequest : Inherits
    Request --|> CallToolRequest : Inherits
    Request --|> SetLevelRequest : Inherits
    Request --|> CreateMessageRequest : Inherits
    Request --|> CompleteRequest : Inherits
    Request --|> ListRootsRequest : Inherits

    Notification --|> JSONRPCNotification : Inherits
    Notification --|> InitializedNotification : Inherits
    Notification --|> ProgressNotification : Inherits
    Notification --|> ResourceListChangedNotification : Inherits
    Notification --|> ResourceUpdatedNotification : Inherits
    Notification --|> PromptListChangedNotification : Inherits
    Notification --|> ToolListChangedNotification : Inherits
    Notification --|> LoggingMessageNotification : Inherits
    Notification --|> RootsListChangedNotification : Inherits

    note for Request "Generic types added to Request"
    note for Notification "Generic types added to Notification"
Loading

File-Level Changes

Change Details Files
Updated type hints for RequestParamsT and NotificationParamsT to allow `dict[str, Any] None` as valid types.
  • Added `dict[str, Any]
Added type hints to JSONRPCRequest and JSONRPCNotification.
  • Added type hints to JSONRPCRequest.
  • Added type hints to JSONRPCNotification.
src/mcp/types.py
Added type hints to various request and notification classes, including InitializeRequest, InitializedNotification, PingRequest, ProgressNotification, ListResourcesRequest, ListResourceTemplatesRequest, ReadResourceRequest, ResourceListChangedNotification, SubscribeRequest, UnsubscribeRequest, ResourceUpdatedNotification, ListPromptsRequest, GetPromptRequest, PromptListChangedNotification, ListToolsRequest, CallToolRequest, ToolListChangedNotification, SetLevelRequest, LoggingMessageNotification, CreateMessageRequest, CompleteRequest, ListRootsRequest, and RootsListChangedNotification.
  • Added type hints to InitializeRequest.
  • Added type hints to InitializedNotification.
  • Added type hints to PingRequest.
  • Added type hints to ProgressNotification.
  • Added type hints to ListResourcesRequest.
  • Added type hints to ListResourceTemplatesRequest.
  • Added type hints to ReadResourceRequest.
  • Added type hints to ResourceListChangedNotification.
  • Added type hints to SubscribeRequest.
  • Added type hints to UnsubscribeRequest.
  • Added type hints to ResourceUpdatedNotification.
  • Added type hints to ListPromptsRequest.
  • Added type hints to GetPromptRequest.
  • Added type hints to PromptListChangedNotification.
  • Added type hints to ListToolsRequest.
  • Added type hints to CallToolRequest.
  • Added type hints to ToolListChangedNotification.
  • Added type hints to SetLevelRequest.
  • Added type hints to LoggingMessageNotification.
  • Added type hints to CreateMessageRequest.
  • Added type hints to CompleteRequest.
  • Added type hints to ListRootsRequest.
  • Added type hints to RootsListChangedNotification.
src/mcp/types.py
Added a test case to address issue modelcontextprotocol#355, which involves type errors related to lifespan context.
  • Created a new test file tests/issues/test_355_type_error.py.
  • Implemented a test case that simulates a database connection within a lifespan context.
  • Defined an AppContext dataclass to hold the database instance.
  • Created an app_lifespan async context manager to handle database connection and disconnection.
  • Defined a query_db tool that accesses the database instance from the lifespan context.
tests/issues/test_355_type_error.py
Removed exclude = ["src/mcp/types.py"] from pyproject.toml.
  • Removed exclude = ["src/mcp/types.py"] from pyproject.toml.
pyproject.toml
Minor assertion message change in src/mcp/server/fastmcp/server.py.
  • Changed assert self._fastmcp is not None, ("Context is not available outside of a request") to assert (self._fastmcp is not None), "Context is not available outside of a request".
src/mcp/server/fastmcp/server.py
Minor assertion message change in tests/shared/test_sse.py.
  • Changed raise RuntimeError(f"Server failed to start after {max_attempts} attempts") to raise RuntimeError(f"Server failed to start after {max_attempts} attempts").
tests/shared/test_sse.py
Minor assertion message change in tests/shared/test_ws.py.
  • Changed raise RuntimeError(f"Server failed to start after {max_attempts} attempts") to raise RuntimeError(f"Server failed to start after {max_attempts} attempts").
tests/shared/test_ws.py
Added LifespanContextT to the generic type parameters of the progress function in src/mcp/shared/progress.py.
  • Added LifespanContextT to the generic type parameters of the progress function.
src/mcp/shared/progress.py
Modified the definition of LifespanContextT in src/mcp/shared/context.py.
  • Changed LifespanContextT = TypeVar("LifespanContextT", default=None) to LifespanContextT = TypeVar("LifespanContextT").
src/mcp/shared/context.py

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

coderabbitai bot commented Mar 26, 2025

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

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

Successfully merging this pull request may close these issues.

1 participant