feat: Add authentication to the endpoints #34
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Adds optional API key authentication to secure MCP proxy endpoints.
Changes
X-API-Keyheader--apiKeyCLI option andMCP_PROXY_API_KEYenvironment variable supportImplementation Details
X-API-Keyheader for simplicity and broad client supportTesting
Manual verification commands
npx tsx src/bin/mcp-proxy.ts --debug --apiKey "test-secret-key" tsx src/fixtures/simple-stdio-server.tsTest commands:
curl -X POST http://localhost:8080/mcp \ -H "Content-Type: application/json" \ -d '{"jsonrpc":"2.0","method":"test","id":1}' \ -w "\nStatus: %{http_code}\n"curl -X POST http://localhost:8080/mcp \ -H "X-API-Key: wrong-key" \ -H "Content-Type: application/json" \ -d '{"jsonrpc":"2.0","method":"test","id":1}' \ -w "\nStatus: %{http_code}\n"curl -X POST http://localhost:8080/mcp \ -H "X-API-Key: test-secret-key" \ -H "Content-Type: application/json" \ -d '{"jsonrpc":"2.0","method":"initialize","params":{"protocolVersion":"2024-11-05","capabilities":{},"clientInfo":{"name":"test-client","version":"1.0.0"}},"id":1}' \ -w "\nStatus: %{http_code}\n"curl http://localhost:8080/ping -w "\nStatus: %{http_code}\n"curl -X OPTIONS http://localhost:8080/mcp -w "\nStatus: %{http_code}\n"curl -X POST http://localhost:8080/mcp \ -H "X-Api-Key: test-secret-key" \ -H "Content-Type: application/json" \ -d '{"jsonrpc":"2.0","method":"test","id":1}' \ -w "\nStatus: %{http_code}\n"Breaking Changes
None. Authentication is opt-in.