mcp-go icon indicating copy to clipboard operation
mcp-go copied to clipboard

fix SSEOption

Open a67793581 opened this issue 8 months ago • 3 comments

SSEOption should not have negative effects when used repeatedly but should always remain consistent.

Summary by CodeRabbit

  • New Features

    • Enhanced service endpoint configuration with improved URL validation and consistent path construction to prevent misconfigurations and ensure reliable service behavior.
  • Tests

    • Added a new test case to ensure consistent behavior of the service configuration when instantiated multiple times with random options.
    • Updated existing test assertions for baseURL and HTTP server handling.

a67793581 avatar Mar 21 '25 07:03 a67793581

Walkthrough

This update enhances the validation logic for the baseURL in the WithBaseURL function of the SSEServer struct. It introduces checks for non-empty values, valid schemes, and proper formatting. The WithBasePath function has been modified to change how the base path is managed. New methods for constructing complete URLs and extracting paths have been added, improving code organization. Additionally, a new test case ensures consistent behavior of the SSEServer when instantiated multiple times with various options.

Changes

File(s) Change Summary
server/sse.go Enhanced URL validation in WithBaseURL (checking for non-empty host, trimming trailing slashes) and removed direct concatenation in WithBasePath. Added new methods: GetUrlPath, CompleteSseEndpoint, CompleteSsePath, CompleteMessageEndpoint, and CompleteMessagePath. Updated handleSSE and ServeHTTP methods to utilize these new helpers.
server/sse_test.go Added a new test case in TestSSEServer to verify that repeated use of configuration options maintains consistent SSEServer properties. Modified existing test assertions regarding baseURL and HTTP server handling.

Possibly related issues

  • mark3labs/mcp-go#64: The changes enhance the validation and handling of the baseURL in the SSEServer, which is crucial for the consistency checks performed in the test case added in the retrieved issue.

Possibly related PRs

  • mark3labs/mcp-go#48: Adds a baseURL parameter to the NewSSEServer function, indicating a direct relationship with the enhanced baseURL validation and handling implemented in this PR.
  • mark3labs/mcp-go#29: Focuses on adding the ServeHTTP method to the SSEServer, indicating a direct relationship with the changes made to URL handling in this PR.
  • mark3labs/mcp-go#45: Introduces a new method for setting basePath, indicating a direct relationship with the modifications to baseURL and basePath management in this PR.

Suggested reviewers

  • ezynda3

📜 Recent review details

Configuration used: CodeRabbit UI Review profile: CHILL Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 970aa8f2c6ad76fe09c6061922ae2227884ff41f and 147f5502df402db51b265a6e391463f032ced484.

📒 Files selected for processing (1)
  • server/sse.go (4 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • server/sse.go

🪧 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 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.

coderabbitai[bot] avatar Mar 21 '25 07:03 coderabbitai[bot]

@a67793581 could you please address the coderabbit comments with either a fix or justifcation?

ezynda3 avatar Mar 21 '25 13:03 ezynda3

@a67793581 could you please address the coderabbit comments with either a fix or justifcation?

Good, thank you very much for the reminder, I have completed the repair

a67793581 avatar Mar 22 '25 03:03 a67793581