Skip to content
Projects
Groups
Snippets
Help
Loading...
Sign in
Toggle navigation
N
next.js
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Alex
next.js
Commits
5e59617d
Unverified
Commit
5e59617d
authored
Oct 07, 2025
by
Jiachi Liu
Committed by
GitHub
Oct 07, 2025
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
[mcp] change get-project-path to get-project-metadata (#84619)
parent
9962fa56
Hide whitespace changes
Inline
Side-by-side
Showing
6 changed files
with
74 additions
and
51 deletions
+74
-51
hot-reloader-turbopack.ts
packages/next/src/server/dev/hot-reloader-turbopack.ts
+5
-4
hot-reloader-webpack.ts
packages/next/src/server/dev/hot-reloader-webpack.ts
+8
-6
get-mcp-middleware.ts
packages/next/src/server/mcp/get-mcp-middleware.ts
+6
-14
get-or-create-mcp-server.ts
packages/next/src/server/mcp/get-or-create-mcp-server.ts
+24
-13
get-project-metadata.ts
packages/next/src/server/mcp/tools/get-project-metadata.ts
+11
-5
mcp-server-get-project-metadata.test.ts
...opment/mcp-server/mcp-server-get-project-metadata.test.ts
+20
-9
No files found.
packages/next/src/server/dev/hot-reloader-turbopack.ts
View file @
5e59617d
...
@@ -758,12 +758,13 @@ export async function createHotReloaderTurbopack(
...
@@ -758,12 +758,13 @@ export async function createHotReloaderTurbopack(
}),
}),
...(
nextConfig
.
experimental
.
mcpServer
...(
nextConfig
.
experimental
.
mcpServer
?
[
?
[
getMcpMiddleware
(
getMcpMiddleware
(
{
projectPath
,
projectPath
,
distDir
,
distDir
,
(
message
)
=>
hotReloader
.
send
(
message
),
sendHmrMessage
:
(
message
)
=>
hotReloader
.
send
(
message
),
()
=>
clients
.
size
getActiveConnectionCount
:
()
=>
clients
.
size
,
),
getDevServerUrl
:
()
=>
process
.
env
.
__NEXT_PRIVATE_ORIGIN
,
}),
]
]
:
[]),
:
[]),
]
]
...
...
packages/next/src/server/dev/hot-reloader-webpack.ts
View file @
5e59617d
...
@@ -1632,12 +1632,14 @@ export default class HotReloaderWebpack implements NextJsHotReloaderInterface {
...
@@ -1632,12 +1632,14 @@ export default class HotReloaderWebpack implements NextJsHotReloaderInterface {
}),
}),
...(
this
.
config
.
experimental
.
mcpServer
...(
this
.
config
.
experimental
.
mcpServer
?
[
?
[
getMcpMiddleware
(
getMcpMiddleware
({
this
.
dir
,
projectPath
:
this
.
dir
,
this
.
distDir
,
distDir
:
this
.
distDir
,
(
message
)
=>
this
.
send
(
message
),
sendHmrMessage
:
(
message
)
=>
this
.
send
(
message
),
()
=>
this
.
webpackHotMiddleware
?.
getClientCount
()
??
0
getActiveConnectionCount
:
()
=>
),
this
.
webpackHotMiddleware
?.
getClientCount
()
??
0
,
getDevServerUrl
:
()
=>
process
.
env
.
__NEXT_PRIVATE_ORIGIN
,
}),
]
]
:
[]),
:
[]),
]
]
...
...
packages/next/src/server/mcp/get-mcp-middleware.ts
View file @
5e59617d
import
type
{
ServerResponse
,
IncomingMessage
}
from
'http'
import
type
{
ServerResponse
,
IncomingMessage
}
from
'http'
import
{
getOrCreateMcpServer
}
from
'./get-or-create-mcp-server'
import
{
getOrCreateMcpServer
,
type
McpServerOptions
,
}
from
'./get-or-create-mcp-server'
import
{
parseBody
}
from
'../api-utils/node/parse-body'
import
{
parseBody
}
from
'../api-utils/node/parse-body'
import
{
StreamableHTTPServerTransport
}
from
'next/dist/compiled/@modelcontextprotocol/sdk/server/streamableHttp'
import
{
StreamableHTTPServerTransport
}
from
'next/dist/compiled/@modelcontextprotocol/sdk/server/streamableHttp'
import
type
{
HmrMessageSentToBrowser
}
from
'../dev/hot-reloader-types'
export
function
getMcpMiddleware
(
export
function
getMcpMiddleware
(
options
:
McpServerOptions
)
{
projectPath
:
string
,
distDir
:
string
,
sendHmrMessage
:
(
message
:
HmrMessageSentToBrowser
)
=>
void
,
getActiveConnectionCount
:
()
=>
number
)
{
return
async
function
(
return
async
function
(
req
:
IncomingMessage
,
req
:
IncomingMessage
,
res
:
ServerResponse
,
res
:
ServerResponse
,
...
@@ -19,12 +16,7 @@ export function getMcpMiddleware(
...
@@ -19,12 +16,7 @@ export function getMcpMiddleware(
if
(
!
pathname
.
startsWith
(
'/_next/mcp'
))
{
if
(
!
pathname
.
startsWith
(
'/_next/mcp'
))
{
return
next
()
return
next
()
}
}
const
mcpServer
=
getOrCreateMcpServer
(
const
mcpServer
=
getOrCreateMcpServer
(
options
)
projectPath
,
distDir
,
sendHmrMessage
,
getActiveConnectionCount
)
const
transport
=
new
StreamableHTTPServerTransport
({
const
transport
=
new
StreamableHTTPServerTransport
({
sessionIdGenerator
:
undefined
,
sessionIdGenerator
:
undefined
,
})
})
...
...
packages/next/src/server/mcp/get-or-create-mcp-server.ts
View file @
5e59617d
import
{
McpServer
}
from
'next/dist/compiled/@modelcontextprotocol/sdk/server/mcp'
import
{
McpServer
}
from
'next/dist/compiled/@modelcontextprotocol/sdk/server/mcp'
import
{
registerGetProject
PathTool
}
from
'./tools/get-project-path
'
import
{
registerGetProject
MetadataTool
}
from
'./tools/get-project-metadata
'
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
{
registerGetLogsTool
}
from
'./tools/get-logs'
import
{
registerGetActionByIdTool
}
from
'./tools/get-server-action-by-id'
import
{
registerGetActionByIdTool
}
from
'./tools/get-server-action-by-id'
import
type
{
HmrMessageSentToBrowser
}
from
'../dev/hot-reloader-types'
import
type
{
HmrMessageSentToBrowser
}
from
'../dev/hot-reloader-types'
export
interface
McpServerOptions
{
projectPath
:
string
distDir
:
string
sendHmrMessage
:
(
message
:
HmrMessageSentToBrowser
)
=>
void
getActiveConnectionCount
:
()
=>
number
getDevServerUrl
:
()
=>
string
|
undefined
}
let
mcpServer
:
McpServer
|
undefined
let
mcpServer
:
McpServer
|
undefined
export
const
getOrCreateMcpServer
=
(
export
const
getOrCreateMcpServer
=
(
options
:
McpServerOptions
)
=>
{
projectPath
:
string
,
distDir
:
string
,
sendHmrMessage
:
(
message
:
HmrMessageSentToBrowser
)
=>
void
,
getActiveConnectionCount
:
()
=>
number
)
=>
{
if
(
mcpServer
)
{
if
(
mcpServer
)
{
return
mcpServer
return
mcpServer
}
}
...
@@ -23,15 +26,23 @@ export const getOrCreateMcpServer = (
...
@@ -23,15 +26,23 @@ export const getOrCreateMcpServer = (
version
:
'0.1.0'
,
version
:
'0.1.0'
,
})
})
registerGetProjectPathTool
(
mcpServer
,
projectPath
)
registerGetProjectMetadataTool
(
registerGetErrorsTool
(
mcpServer
,
sendHmrMessage
,
getActiveConnectionCount
)
mcpServer
,
options
.
projectPath
,
options
.
getDevServerUrl
)
registerGetErrorsTool
(
mcpServer
,
options
.
sendHmrMessage
,
options
.
getActiveConnectionCount
)
registerGetPageMetadataTool
(
registerGetPageMetadataTool
(
mcpServer
,
mcpServer
,
sendHmrMessage
,
options
.
sendHmrMessage
,
getActiveConnectionCount
options
.
getActiveConnectionCount
)
)
registerGetLogsTool
(
mcpServer
,
distDir
)
registerGetLogsTool
(
mcpServer
,
options
.
distDir
)
registerGetActionByIdTool
(
mcpServer
,
distDir
)
registerGetActionByIdTool
(
mcpServer
,
options
.
distDir
)
return
mcpServer
return
mcpServer
}
}
packages/next/src/server/mcp/tools/get-project-
path
.ts
→
packages/next/src/server/mcp/tools/get-project-
metadata
.ts
View file @
5e59617d
import
type
{
McpServer
}
from
'next/dist/compiled/@modelcontextprotocol/sdk/server/mcp'
import
type
{
McpServer
}
from
'next/dist/compiled/@modelcontextprotocol/sdk/server/mcp'
export
function
registerGetProject
Path
Tool
(
export
function
registerGetProject
Metadata
Tool
(
server
:
McpServer
,
server
:
McpServer
,
projectPath
:
string
projectPath
:
string
,
getDevServerUrl
:
()
=>
string
|
undefined
)
{
)
{
server
.
registerTool
(
server
.
registerTool
(
'get_project_
path
'
,
'get_project_
metadata
'
,
{
{
description
:
description
:
'Returns the
absolute path of the root directory for this Next.js project
.'
,
'Returns the
the metadata of this Next.js project, including project path, dev server URL, etc
.'
,
inputSchema
:
{},
inputSchema
:
{},
},
},
async
(
_request
)
=>
{
async
(
_request
)
=>
{
...
@@ -24,11 +25,16 @@ export function registerGetProjectPathTool(
...
@@ -24,11 +25,16 @@ export function registerGetProjectPathTool(
}
}
}
}
const
devServerUrl
=
getDevServerUrl
()
return
{
return
{
content
:
[
content
:
[
{
{
type
:
'text'
,
type
:
'text'
,
text
:
projectPath
,
text
:
JSON
.
stringify
({
projectPath
,
devServerUrl
,
}),
},
},
],
],
}
}
...
...
test/development/mcp-server/mcp-server-get-project-
path
.test.ts
→
test/development/mcp-server/mcp-server-get-project-
metadata
.test.ts
View file @
5e59617d
import
{
FileRef
,
nextTestSetup
}
from
'e2e-utils'
import
{
FileRef
,
nextTestSetup
}
from
'e2e-utils'
import
path
from
'path'
import
path
from
'path'
describe
(
'mcp-server get_project_
path
tool'
,
()
=>
{
describe
(
'mcp-server get_project_
metadata
tool'
,
()
=>
{
const
{
next
}
=
nextTestSetup
({
const
{
next
}
=
nextTestSetup
({
files
:
new
FileRef
(
path
.
join
(
__dirname
,
'fixtures'
,
'default-template'
)),
files
:
new
FileRef
(
path
.
join
(
__dirname
,
'fixtures'
,
'default-template'
)),
})
})
it
(
'should return correct project
path via get_project_path
tool'
,
async
()
=>
{
it
(
'should return correct project
metadata via get_project_metadata
tool'
,
async
()
=>
{
const
mcpEndpoint
=
`
${
next
.
url
}
/_next/mcp`
const
mcpEndpoint
=
`
${
next
.
url
}
/_next/mcp`
// Call get_project_
path
tool
// Call get_project_
metadata
tool
const
callToolResponse
=
await
fetch
(
mcpEndpoint
,
{
const
callToolResponse
=
await
fetch
(
mcpEndpoint
,
{
method
:
'POST'
,
method
:
'POST'
,
headers
:
{
headers
:
{
...
@@ -20,7 +20,7 @@ describe('mcp-server get_project_path tool', () => {
...
@@ -20,7 +20,7 @@ describe('mcp-server get_project_path tool', () => {
id
:
'call-tool-1'
,
id
:
'call-tool-1'
,
method
:
'tools/call'
,
method
:
'tools/call'
,
params
:
{
params
:
{
name
:
'get_project_
path
'
,
name
:
'get_project_
metadata
'
,
arguments
:
{},
arguments
:
{},
},
},
}),
}),
...
@@ -38,12 +38,23 @@ describe('mcp-server get_project_path tool', () => {
...
@@ -38,12 +38,23 @@ describe('mcp-server get_project_path tool', () => {
expect
(
content
).
toBeInstanceOf
(
Array
)
expect
(
content
).
toBeInstanceOf
(
Array
)
expect
(
content
?.[
0
]?.
type
).
toBe
(
'text'
)
expect
(
content
?.[
0
]?.
type
).
toBe
(
'text'
)
const
actualProjectPath
=
content
?.[
0
]?.
text
const
metadataText
=
content
?.[
0
]?.
text
expect
(
metadataText
).
toBeTruthy
()
// Verify it's an absolute path
const
metadata
=
JSON
.
parse
(
metadataText
)
expect
(
path
.
isAbsolute
(
actualProjectPath
)).
toBe
(
true
)
// Should match the test directory
// Verify projectPath
expect
(
actualProjectPath
).
toBe
(
next
.
testDir
)
expect
(
metadata
.
projectPath
).
toBeTruthy
()
expect
(
path
.
isAbsolute
(
metadata
.
projectPath
)).
toBe
(
true
)
expect
(
metadata
.
projectPath
).
toBe
(
next
.
testDir
)
// Verify devServerUrl
expect
(
metadata
.
devServerUrl
).
toBeTruthy
()
expect
(
metadata
.
devServerUrl
).
toMatch
(
/^https
?
:
\/\/
/
)
expect
(
metadata
.
devServerUrl
).
toContain
(
'localhost'
)
// The devServerUrl should match the next.url (base URL without path)
const
expectedBaseUrl
=
next
.
url
expect
(
metadata
.
devServerUrl
).
toBe
(
expectedBaseUrl
)
})
})
})
})
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment