Skip to content

Commit a54b513

Browse files
authored
Test the MCP probe User-Agent (#2259)
1 parent 8e4a8a4 commit a54b513

1 file changed

Lines changed: 98 additions & 0 deletions

File tree

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
import { describe, expect, it } from "@effect/vitest";
2+
import { Effect, Layer } from "effect";
3+
import { HttpClient, HttpClientRequest, HttpClientResponse } from "effect/unstable/http";
4+
5+
import { probeMcpEndpointShape } from "./probe-shape";
6+
7+
const endpoint = "https://mcp.example/mcp";
8+
const metadataUrl = "https://mcp.example/.well-known/oauth-protected-resource/mcp";
9+
10+
interface RecordedRequest {
11+
readonly method: string;
12+
readonly url: string;
13+
readonly mcpProtocolVersion: string | undefined;
14+
readonly userAgent: string | undefined;
15+
}
16+
17+
/** Records every request and answers with `respond`'s status. */
18+
const recordingClientLayer = (
19+
recorded: Array<RecordedRequest>,
20+
respond: (request: HttpClientRequest.HttpClientRequest) => number,
21+
) =>
22+
Layer.succeed(HttpClient.HttpClient)(
23+
HttpClient.make((request: HttpClientRequest.HttpClientRequest) => {
24+
recorded.push({
25+
method: request.method,
26+
url: request.url,
27+
mcpProtocolVersion: request.headers["mcp-protocol-version"],
28+
userAgent: request.headers["user-agent"],
29+
});
30+
return Effect.succeed(
31+
HttpClientResponse.fromWeb(request, new Response("", { status: respond(request) })),
32+
);
33+
}),
34+
);
35+
36+
/** POST → 405, so the probe falls back to GET; GET → 401 with no Bearer
37+
* challenge, so the probe reads RFC 9728 metadata, which is missing. */
38+
const challengeWithoutBearer = (request: HttpClientRequest.HttpClientRequest): number =>
39+
request.method === "POST" ? 405 : request.url === endpoint ? 401 : 404;
40+
41+
const summarize = (recorded: ReadonlyArray<RecordedRequest>) =>
42+
recorded.map((request) => ({
43+
request: `${request.method} ${request.url}${
44+
request.mcpProtocolVersion ? ` (${request.mcpProtocolVersion})` : ""
45+
}`,
46+
userAgent: request.userAgent,
47+
}));
48+
49+
describe("MCP shape probe User-Agent", () => {
50+
it.effect("sends a default User-Agent on the probe and its OAuth metadata request", () =>
51+
Effect.gen(function* () {
52+
const recorded: Array<RecordedRequest> = [];
53+
54+
yield* probeMcpEndpointShape(endpoint, {
55+
httpClientLayer: recordingClientLayer(recorded, challengeWithoutBearer),
56+
});
57+
58+
expect(summarize(recorded)).toEqual([
59+
{ request: `POST ${endpoint}`, userAgent: "executor" },
60+
{ request: `GET ${endpoint}`, userAgent: "executor" },
61+
{ request: `GET ${metadataUrl}`, userAgent: "executor" },
62+
]);
63+
}),
64+
);
65+
66+
it.effect("sends a default User-Agent on the discover request", () =>
67+
Effect.gen(function* () {
68+
const recorded: Array<RecordedRequest> = [];
69+
70+
yield* probeMcpEndpointShape(endpoint, {
71+
httpClientLayer: recordingClientLayer(recorded, () => 404),
72+
});
73+
74+
expect(summarize(recorded)).toEqual([
75+
{ request: `POST ${endpoint}`, userAgent: "executor" },
76+
{ request: `GET ${endpoint}`, userAgent: "executor" },
77+
{ request: `POST ${endpoint} (2026-07-28)`, userAgent: "executor" },
78+
]);
79+
}),
80+
);
81+
82+
it.effect("keeps a configured User-Agent on every probe request", () =>
83+
Effect.gen(function* () {
84+
const recorded: Array<RecordedRequest> = [];
85+
86+
yield* probeMcpEndpointShape(endpoint, {
87+
headers: { "User-Agent": "custom-agent/1.0" },
88+
httpClientLayer: recordingClientLayer(recorded, challengeWithoutBearer),
89+
});
90+
91+
expect(summarize(recorded)).toEqual([
92+
{ request: `POST ${endpoint}`, userAgent: "custom-agent/1.0" },
93+
{ request: `GET ${endpoint}`, userAgent: "custom-agent/1.0" },
94+
{ request: `GET ${metadataUrl}`, userAgent: "custom-agent/1.0" },
95+
]);
96+
}),
97+
);
98+
});

0 commit comments

Comments
 (0)