[Improvement]: Custom response when making a get request to /mcp

[MichaelCrowcroft]

What would you like to improve?

Making a get request to the /mcp server route currently returns an error - method not allowed.

Proposed Solution

Would it be possible for us to be able to create a standard intro page that shows here (eg. listing the tools) or possibly we set a config allowing the get request to be overwritten in the web.php routes of a laravel app?

[kargnas]

@claude Suggest options for this

[claude]

Claude finished @kargnas's task —— View job

---

Tasks

• Analyze current MCP server route handling
• Review proposed solutions and suggest options
• Provide recommendations

Analysis

I've analyzed the current implementation and the issue request. Here's what I found:

Current Behavior

The StreamableHttpController::getHandle() method currently returns a 405 Method Not Allowed error for GET requests to /mcp:

public function getHandle(Request $request)
{
    // ...
    return response()->json([
        'jsonrpc' => '2.0',
        'error' => 'Method Not Allowed',
    ], 405);
}

Suggested Options

Here are several options to handle GET requests to the /mcp endpoint:

Option 1: Info Page with Tool Listing (Recommended)

Create an informative HTML or JSON response that displays:

• Server name and version
• Available tools with their descriptions
• Available resources and resource templates
• Basic usage instructions

Pros:

• User-friendly for developers exploring the API
• Self-documenting
• No breaking changes

Implementation approach:

• Modify StreamableHttpController::getHandle() to return server info
• Could be HTML (for browser viewing) or JSON (for programmatic access)
• Use content negotiation based on Accept header

Option 2: Configurable Route Override

Add a config option to disable the default GET route, allowing developers to define custom routes in their web.php:

// config/mcp-server.php
'override_get_route' => false, // When true, doesn't register GET route

// In app's web.php (when override enabled)
Route::get('/mcp', [CustomController::class, 'showDashboard']);

Pros:

• Maximum flexibility
• Developers can create custom dashboards or documentation

Cons:

• Requires additional configuration
• May confuse users if not well documented

Option 3: Configurable Response Type

Add configuration to choose the GET response behavior:

// config/mcp-server.php
'get_response' => 'info', // Options: 'info', 'disabled', 'custom'
'custom_get_handler' => null, // Custom handler class when 'custom' is selected

Pros:

• Balance between flexibility and simplicity
• Backward compatible with default behavior

Option 4: Health Check Endpoint

Simple health check response for monitoring:

{
    "status": "ok",
    "server": "OP.GG MCP Server",
    "version": "0.1.0",
    "timestamp": "2025-08-18T16:30:00Z"
}

Pros:

• Useful for monitoring and load balancers
• Lightweight

Cons:

• Limited information

Recommendation

I recommend Option 1 (Info Page) as the default behavior, with Option 3 (Configurable Response) for flexibility:

1. Default GET response shows server info, tools, and resources
2. Add config option to customize or disable this behavior
3. Support both HTML (for browsers) and JSON (for API clients) via content negotiation

This approach provides:

• Immediate value without configuration
• Developer-friendly exploration
• Flexibility for custom implementations
• Backward compatibility path

The implementation would involve:

1. Creating a new response formatter for server info
2. Updating StreamableHttpController::getHandle()
3. Adding configuration options
4. Documenting the feature in README

Would you like me to implement any of these options?

[kargnas]

@claude

1. Use the first option, make a default info page with very simple information, not too much, for security.
2. Allow overriding, but cleaner way

[claude]

Claude finished @kargnas's task —— View job • claude/issue-63-20250818-1622 • Create PR ➔

---

Tasks

• Analyze current implementation and understand request
• Read StreamableHttpController to understand current behavior
• Design simple info page response
• Implement default info page in getHandle()
• Add configuration option for clean override
• Test the implementation
• Commit and push changes

Completed Implementation

I've successfully implemented the requested features:

1. Simple Info Page (Default Behavior)

• GET requests to /mcp now return a simple info page instead of 405 error
• Content negotiation: Returns HTML for browsers, JSON for API clients
• Minimal information displayed for security:
  • Server name and version
  • Protocol type (MCP)
  • Transport type (Streamable HTTP)

2. Clean Override Mechanism

• Added new config option: get_handler in config/mcp-server.php
• When null (default): Uses the built-in info page
• When set to a class name: Uses custom handler
• Custom handlers must implement a handle(Request $request) method
• Fully documented with example in the config file

Changes Made

• Modified StreamableHttpController::getHandle() to check for custom handler first, then fall back to default info page
• Added private method generateInfoHtml() for clean HTML generation
• Added comprehensive configuration documentation with examples

The implementation maintains backward compatibility while providing a much better user experience when accessing the MCP endpoint via browser or API client.

|