Unverified Commit 79ae926d authored by Jiachi Liu's avatar Jiachi Liu Committed by GitHub

[mcp] expose logging (#84226)

parent 06207d84
...@@ -751,6 +751,7 @@ export async function createHotReloaderTurbopack( ...@@ -751,6 +751,7 @@ export async function createHotReloaderTurbopack(
? [ ? [
getMcpMiddleware( getMcpMiddleware(
projectPath, projectPath,
distDir,
(message) => hotReloader.send(message), (message) => hotReloader.send(message),
() => clients.size () => clients.size
), ),
......
...@@ -1647,6 +1647,7 @@ export default class HotReloaderWebpack implements NextJsHotReloaderInterface { ...@@ -1647,6 +1647,7 @@ export default class HotReloaderWebpack implements NextJsHotReloaderInterface {
? [ ? [
getMcpMiddleware( getMcpMiddleware(
this.dir, this.dir,
this.distDir,
(message) => this.send(message), (message) => this.send(message),
() => this.webpackHotMiddleware?.getClientCount() ?? 0 () => this.webpackHotMiddleware?.getClientCount() ?? 0
), ),
......
...@@ -6,6 +6,7 @@ import type { HmrMessageSentToBrowser } from '../dev/hot-reloader-types' ...@@ -6,6 +6,7 @@ import type { HmrMessageSentToBrowser } from '../dev/hot-reloader-types'
export function getMcpMiddleware( export function getMcpMiddleware(
projectPath: string, projectPath: string,
distDir: string,
sendHmrMessage: (message: HmrMessageSentToBrowser) => void, sendHmrMessage: (message: HmrMessageSentToBrowser) => void,
getActiveConnectionCount: () => number getActiveConnectionCount: () => number
) { ) {
...@@ -20,6 +21,7 @@ export function getMcpMiddleware( ...@@ -20,6 +21,7 @@ export function getMcpMiddleware(
} }
const mcpServer = getOrCreateMcpServer( const mcpServer = getOrCreateMcpServer(
projectPath, projectPath,
distDir,
sendHmrMessage, sendHmrMessage,
getActiveConnectionCount getActiveConnectionCount
) )
......
...@@ -2,12 +2,14 @@ import { McpServer } from 'next/dist/compiled/@modelcontextprotocol/sdk/server/m ...@@ -2,12 +2,14 @@ import { McpServer } from 'next/dist/compiled/@modelcontextprotocol/sdk/server/m
import { registerGetProjectPathTool } from './tools/get-project-path' import { registerGetProjectPathTool } from './tools/get-project-path'
import { registerGetErrorsTool } from './tools/get-errors' import { registerGetErrorsTool } from './tools/get-errors'
import { registerGetPageMetadataTool } from './tools/get-page-metadata' import { registerGetPageMetadataTool } from './tools/get-page-metadata'
import { registerGetLogsTool } from './tools/get-logs'
import type { HmrMessageSentToBrowser } from '../dev/hot-reloader-types' import type { HmrMessageSentToBrowser } from '../dev/hot-reloader-types'
let mcpServer: McpServer | undefined let mcpServer: McpServer | undefined
export const getOrCreateMcpServer = ( export const getOrCreateMcpServer = (
projectPath: string, projectPath: string,
distDir: string,
sendHmrMessage: (message: HmrMessageSentToBrowser) => void, sendHmrMessage: (message: HmrMessageSentToBrowser) => void,
getActiveConnectionCount: () => number getActiveConnectionCount: () => number
) => { ) => {
...@@ -27,6 +29,7 @@ export const getOrCreateMcpServer = ( ...@@ -27,6 +29,7 @@ export const getOrCreateMcpServer = (
sendHmrMessage, sendHmrMessage,
getActiveConnectionCount getActiveConnectionCount
) )
registerGetLogsTool(mcpServer, distDir)
return mcpServer return mcpServer
} }
/**
* MCP tool for getting the path to the Next.js development log file.
*
* This tool returns the path to the {nextConfig.distDir}/logs/next-development.log file
* that contains browser console logs and other development information.
*/
import type { McpServer } from 'next/dist/compiled/@modelcontextprotocol/sdk/server/mcp'
import { stat } from 'fs/promises'
import { join } from 'path'
export function registerGetLogsTool(server: McpServer, distDir: string) {
server.registerTool(
'get_logs',
{
description:
'Get the path to the Next.js development log file. Returns the file path so the agent can read the logs directly.',
},
async () => {
try {
const logFilePath = join(distDir, 'logs', 'next-development.log')
// Check if the log file exists
try {
await stat(logFilePath)
} catch (error) {
return {
content: [
{
type: 'text',
text: `Log file not found at ${logFilePath}.`,
},
],
}
}
return {
content: [
{
type: 'text',
text: `Next.js log file path: ${logFilePath}`,
},
],
}
} catch (error) {
return {
content: [
{
type: 'text',
text: `Error getting log file path: ${error instanceof Error ? error.message : String(error)}`,
},
],
}
}
}
)
}
'use client'
import { useEffect } from 'react'
export default function ClientPage() {
useEffect(() => {
// Logging in client component useEffect
// Test complex partial circular object
const circularObj: any = {
name: 'test',
data: {
nested: {
value: 42,
items: [1, 2, 3],
},
},
metadata: {
name: 'safe stringify',
version: '1.0.0',
},
}
// Create partial circular reference
circularObj.data.parent = circularObj
console.log('Client: Complex circular object:', circularObj)
console.error('Client: This is an error message from client component')
console.warn('Client: This is a warning message from client component')
}, [])
return <p>client page with logging</p>
}
import { ReactNode } from 'react'
export default function Root({ children }: { children: ReactNode }) {
return (
<html>
<body>{children}</body>
</html>
)
}
export default async function Page() {
// Logging in RSC render
console.log('RSC: This is a log message from server component')
console.error('RSC: This is an error message from server component')
console.warn('RSC: This is a warning message from server component')
return <p>hello world</p>
}
/**
* @type {import('next').NextConfig}
*/
const nextConfig = {
experimental: {
mcpServer: true,
},
}
module.exports = nextConfig
import { GetServerSideProps } from 'next'
interface Props {
message: string
}
export default function Page({ message }: Props) {
console.log('Pages Router isomorphic: This is a log message from render')
return (
<div>
<h1>Pages Router Server-Side Props Test</h1>
<p>{message}</p>
</div>
)
}
export const getServerSideProps: GetServerSideProps<Props> = async () => {
console.log('Pages Router SSR: This is a log message from getServerSideProps')
console.error(
'Pages Router SSR: This is an error message from getServerSideProps'
)
console.warn(
'Pages Router SSR: This is a warning message from getServerSideProps'
)
return {
props: {
message: 'Server-side props executed successfully',
},
}
}
{
"compilerOptions": {
"target": "ES2017",
"lib": ["dom", "dom.iterable", "esnext"],
"allowJs": true,
"skipLibCheck": true,
"strict": true,
"noEmit": true,
"esModuleInterop": true,
"module": "esnext",
"moduleResolution": "bundler",
"resolveJsonModule": true,
"isolatedModules": true,
"jsx": "react-jsx",
"incremental": true,
"plugins": [
{
"name": "next"
}
],
"paths": {
"@/*": ["./*"]
}
},
"include": [
"next-env.d.ts",
"**/*.ts",
"**/*.tsx",
".next/types/**/*.ts",
"**/*.mts"
],
"exclude": ["node_modules", "**/*.test.ts", "**/*.test.tsx"]
}
import path from 'path'
import { nextTestSetup } from 'e2e-utils'
import { retry } from 'next-test-utils'
describe('get-logs MCP tool', () => {
const { next, skipped } = nextTestSetup({
files: path.join(__dirname, 'fixtures', 'log-file-app'),
skipDeployment: true,
})
if (skipped) {
return
}
async function callGetLogs(id: string): Promise<string> {
const response = await fetch(`${next.url}/_next/mcp`, {
method: 'POST',
headers: {
'Content-Type': 'application/json',
Accept: 'application/json, text/event-stream',
},
body: JSON.stringify({
jsonrpc: '2.0',
id,
method: 'tools/call',
params: { name: 'get_logs', arguments: {} },
}),
})
const text = await response.text()
const match = text.match(/data: ({.*})/s)
const result = JSON.parse(match![1])
return result.result?.content?.[0]?.text
}
it('should return log file path via MCP get_logs tool', async () => {
// Generate some logs by visiting pages that create log entries
await next.browser('/server')
await next.browser('/client')
await next.browser('/pages-router-page')
await retry(async () => {
const sessionId = 'test-mcp-logs-' + Date.now()
const response = await callGetLogs(sessionId)
// Should return the log file path
expect(response).toContain('Next.js log file path:')
expect(response).toContain('logs/next-development.log')
expect(response).not.toContain('Log file not found at')
})
})
})
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment