diff --git a/.changeset/mcp-guideline-redirects.md b/.changeset/mcp-guideline-redirects.md new file mode 100644 index 00000000000..a756928d991 --- /dev/null +++ b/.changeset/mcp-guideline-redirects.md @@ -0,0 +1,5 @@ +--- +'@primer/mcp': patch +--- + +Guidelines: Avoid returning homepage content when a component has no guidelines page. diff --git a/packages/mcp/src/server.test.ts b/packages/mcp/src/server.test.ts index 8ad20d21a04..e2e87197d68 100644 --- a/packages/mcp/src/server.test.ts +++ b/packages/mcp/src/server.test.ts @@ -532,6 +532,38 @@ describe('MCP server', () => { expect(fetchMock.mock.calls[0]?.[0].toString()).toBe(expectedUrl) }) + it.each([ + { + tool: 'get_component_usage_guidelines', + expectedPath: '/product/components/card/guidelines', + expectedMessage: 'There are no usage guidelines for the `Card` component', + }, + { + tool: 'get_component_accessibility_guidelines', + expectedPath: '/product/components/card/accessibility', + expectedMessage: 'There are no accessibility guidelines for the `Card` component', + }, + ])('$tool does not return homepage content after a redirect', async ({tool, expectedPath, expectedMessage}) => { + const fetchMock = vi.mocked(fetch) + fetchMock.mockResolvedValue(responseWithFinalUrl('

Primer homepage

', 'https://primer.style/')) + + const result = await client.callTool({name: tool, arguments: {name: 'Card'}}) + + expect(fetchMock).toHaveBeenCalledWith(new URL(expectedPath, 'https://primer.style')) + expect(result.content).toContainEqual( + expect.objectContaining({ + type: 'text', + text: expect.stringContaining(expectedMessage), + }), + ) + expect(result.content).not.toContainEqual( + expect.objectContaining({ + type: 'text', + text: expect.stringContaining('Primer homepage'), + }), + ) + }) + it.each(['ConfirmationDialog', 'confirmationdialog'])( 'retrieves ConfirmationDialog documentation for %s from its published URL', async name => { diff --git a/packages/mcp/src/server.ts b/packages/mcp/src/server.ts index 9477b1da702..4af4e1e7c58 100644 --- a/packages/mcp/src/server.ts +++ b/packages/mcp/src/server.ts @@ -28,6 +28,15 @@ const turndownService = new TurndownService() // Load all tokens with guidelines from primitives const allTokensWithGuidelines: TokenWithGuidelines[] = loadAllTokensWithGuidelines() +function hasRedirectedToDifferentPage(response: Response, url: URL): boolean { + if (!response.url) { + return false + } + + const finalUrl = new URL(response.url) + return finalUrl.origin !== url.origin || finalUrl.pathname.replace(/\/$/, '') !== url.pathname.replace(/\/$/, '') +} + function createServer() { const server = new McpServer({ name: 'Primer', @@ -316,13 +325,18 @@ ${text}`, const url = new URL(`/product/components/${match.slug}/guidelines`, 'https://primer.style') const response = await fetch(url) - if (!response.ok) { - if ((response.status >= 400 && response.status < 500) || (response.status >= 300 && response.status < 400)) { + const redirected = hasRedirectedToDifferentPage(response, url) + if (!response.ok || redirected) { + if ( + redirected || + (response.status >= 400 && response.status < 500) || + (response.status >= 300 && response.status < 400) + ) { return { content: [ { type: 'text', - text: `There are no accessibility guidelines for the \`${name}\` component in the @primer/react package.`, + text: `There are no usage guidelines for the \`${name}\` component in the @primer/react package.`, }, ], } @@ -389,8 +403,13 @@ ${text}`, const url = new URL(`/product/components/${match.slug}/accessibility`, 'https://primer.style') const response = await fetch(url) - if (!response.ok) { - if ((response.status >= 400 && response.status < 500) || (response.status >= 300 && response.status < 400)) { + const redirected = hasRedirectedToDifferentPage(response, url) + if (!response.ok || redirected) { + if ( + redirected || + (response.status >= 400 && response.status < 500) || + (response.status >= 300 && response.status < 400) + ) { return { content: [ {