PhpStorm 2025.2 Help

MCP 服务器

2025.2 版本开始,PhpStorm 内置了 MCP server ,允许 Claude Desktop、Cursor、VS Code 等外部客户端访问 IDE 提供的工具。 这使用户能够在其首选应用中控制并与 JetBrains IDE 交互。

外部客户端设置

对于如 Claude CodeClaude DesktopCursorVS CodeWindsurf 等外部客户端,可自动完成配置:

  1. 在主菜单中,进入 设置 | 工具 | MCP Server.

  2. 点击 启用 MCP Server

  3. 客户端自动配置 部分中,为每一个要与 MCP server 配合使用的客户端点击 自动配置。 这将自动更新其 JSON 配置。

    MCP 服务器设置
  4. 请重新启动客户端以使配置生效。

如果您希望从其他客户端连接到 MCP server,则需要进行手动配置:

  1. 手动客户端配置 部分中,根据连接类型点击 复制 SSE 配置复制 Stdio 配置

    MCP 服务器手动配置
  2. 将复制的配置粘贴到客户端的设置或配置文件中。

  3. 请重新启动客户端以使配置生效。

无需确认执行操作

MCP server 允许已连接的外部客户端无需每次都用户确认即可在 IDE 中执行终端命令或运行配置。

要启用此模式:

  1. 在主菜单中,进入 设置 | 工具 | MCP Server.

  2. 命令执行 部分,启用 在无需确认的情况下运行 shell 命令或运行配置(大胆模式) 设置。

  3. 点击 Apply

支持的工具

以下是 MCP server 提供的工具列表:

execute_run_configuration

在当前项目中运行特定的运行配置,并等待其在指定超时时间内完成。 使用此工具可执行通过 get_run_configurations 工具获取的运行配置。

返回执行结果,包括退出代码、输出内容和是否成功的状态。

参数:

  • configurationName :要执行的运行配置名称。

  • timeout :超时时间,单位为毫秒。

  • maxLinesCount :返回的最大行数。

  • truncateMode :截断文本的方式:从开头、中间、结尾处截断,或不进行截断。

  • projectPath :项目路径。 如已知该值,请务必提供,以减少调用歧义。 如果仅知道当前工作目录,可将其作为项目路径使用。

get_run_configurations

返回当前项目的运行配置列表。 运行配置定义了如何从源代码运行应用程序、任务或测试套件。

此工具还会提供额外信息,如命令行、工作目录和环境变量(如有)。

使用此工具可查询当前项目中可用的运行配置列表。

参数:

  • projectPath :项目路径。 如已知该值,请务必提供,以减少调用歧义。 如果仅知道当前工作目录,可将其作为项目路径使用。

get_file_problems

使用 IntelliJ 检查功能分析指定文件中的错误和警告。 使用此工具可识别特定文件中的代码问题、语法错误及其他问题。

返回问题列表,包括严重性、描述和位置等信息。

参数:

  • filePath :相对于项目根目录的路径。

  • errorsOnly :是否仅包含错误,或同时包含错误和警告。

  • timeout :超时时间,单位为毫秒。

  • projectPath :项目路径。 如已知该值,请务必提供,以减少调用歧义。 如果仅知道当前工作目录,可将其作为项目路径使用。

get_project_dependencies

返回项目中定义的所有依赖项列表。 提供有关库名称的结构化信息。

参数:

  • projectPath :项目路径。 如已知该值,请务必提供,以减少调用歧义。 如果仅知道当前工作目录,可将其作为项目路径使用。

get_project_modules

返回项目中所有模块及其类型的列表。 提供关于每个模块的结构化信息,包括其名称和类型。

参数:

  • projectPath :项目路径。 如已知该值,请务必提供,以减少调用歧义。 如果仅知道当前工作目录,可将其作为项目路径使用。

create_new_file

在项目目录中指定路径处创建新文件。 可选择向新文件中写入提供的文本内容。

参数:

  • pathInProject :相对于项目根目录应创建文件的路径。

  • text (可选):要写入新文件的内容。

  • overwrite :是否覆盖已有文件。 如设置为 false ,发生冲突时将抛出异常。

  • projectPath :项目路径。 如已知该值,请务必提供,以减少调用歧义。 如果仅知道当前工作目录,可将其作为项目路径使用。

find_files_by_glob

搜索项目中所有相对路径与指定 glob 模式匹配的文件。 搜索会递归遍历项目目录或指定子目录中的所有子目录。 使用此工具可通过 glob 模式(例如 **/*.txt )查找文件。

参数:

  • globPattern :用于搜索的 glob 模式。 模式必须相对于项目根目录。 示例: src/**/*.java

  • subDirectoryRelativePath (可选):相对于项目的子目录以供搜索。

  • addExcluded :是否将已排除/忽略的文件包含在搜索结果中。 文件可能由用户或忽略规则排除。

  • fileCountLimit :返回文件的最大数量。

  • timeout :超时时间,单位为毫秒。

  • projectPath :项目路径。 如已知该值,请务必提供,以减少调用歧义。 如果仅知道当前工作目录,可将其作为项目路径使用。

find_files_by_name_keyword

搜索项目中所有名称包含指定关键字(区分大小写)的文件。 使用此工具可在知道部分文件名的情况下定位文件。

参数:

  • nameKeyword :要在文件名中搜索的子字符串。

  • fileCountLimit :返回文件的最大数量。

  • timeout :超时时间,单位为毫秒。

  • projectPath :项目路径。 如已知该值,请务必提供,以减少调用歧义。 如果仅知道当前工作目录,可将其作为项目路径使用。

get_all_open_file_paths

返回当前活动编辑器或任何其他打开的编辑器中用于编辑的所有文件路径,路径相对于项目根目录。 使用此工具可查看当前打开的编辑器。

参数:

  • projectPath :项目路径。 如已知该值,请务必提供,以减少调用歧义。 如果仅知道当前工作目录,可将其作为项目路径使用。

list_directory_tree

以类似 tree 工具的伪图形格式提供指定目录的树状结构表示。 使用此工具可查看目录或整个项目的内容。 建议使用此工具代替 lsdir 等命令行工具进行目录列表操作。

参数:

  • directoryPath :相对于项目根目录的路径。

  • maxDepth :最大递归深度。

  • timeout :超时时间,单位为毫秒。

  • projectPath :项目路径。 如已知该值,请务必提供,以减少调用歧义。 如果仅知道当前工作目录,可将其作为项目路径使用。

open_file_in_editor

在 JetBrains IDE 编辑器中打开指定文件。 需要一个包含要打开文件路径的 filePath 参数。 文件路径可以是绝对路径,也可以是相对于项目根目录的路径。

参数:

  • filePath :相对于项目根目录的路径。

  • projectPath :项目路径。 如已知该值,请务必提供,以减少调用歧义。 如果仅知道当前工作目录,可将其作为项目路径使用。

reformat_file

在 JetBrains IDE 中重新格式化指定文件。 使用此工具可根据文件路径对文件应用代码格式化。

参数:

  • path :相对于项目根目录的路径。

  • projectPath :项目路径。 如已知该值,请务必提供,以减少调用歧义。 如果仅知道当前工作目录,可将其作为项目路径使用。

get_file_text_by_path

使用相对于项目根目录的路径获取文件文本内容。 当您拥有文件的相对于项目根目录的路径时,可使用此工具读取文件内容。

参数:

  • pathInProject :相对于项目根目录应创建文件的路径。

  • truncateMode :截断文本的方式:从开头、中间、结尾处截断,或不进行截断。

  • maxLinesCount :返回的最大行数。

  • projectPath :项目路径。 如已知该值,请务必提供,以减少调用歧义。 如果仅知道当前工作目录,可将其作为项目路径使用。

replace_text_in_file

通过灵活的查找和替换选项替换文件中的文本。 使用此工具可进行有针对性的更改,而无需替换整个文件内容。 当您清楚要替换的确切文本时,这是修改文件内容最高效的工具。

返回以下响应之一:

  • ok — 替换成功。

  • project dir not found — 无法确定项目目录。

  • file not found — 指定文件不存在。

  • could not get document — 无法访问文件内容。

  • no occurrences found — 文件中未找到要替换的文本。

参数:

  • pathInProject :相对于项目根目录的目标文件路径。

  • oldText :要被替换的文本。

  • newText :替换文本。

  • replaceAll :是否替换所有匹配项。

  • caseSensitive :搜索是否区分大小写。

  • projectPath :项目路径。 如已知该值,请务必提供,以减少调用歧义。 如果仅知道当前工作目录,可将其作为项目路径使用。

search_in_files_by_regex

使用 IntelliJ 的搜索引擎在项目中的所有文件中搜索正则表达式模式。 优先使用此工具而不是通过命令行工具读取文件,因为速度更快。

结果中的匹配项将用 || 字符包裹以突出显示。 例如: some text ||substring|| text

参数:

  • regexPattern :要搜索的正则表达式模式。

  • directoryToSearch :相对于项目根目录的搜索目录。 如果未指定,将搜索整个项目。

  • fileMask :要搜索的文件掩码。 如未指定,将搜索所有文件。 示例: *.java

  • caseSensitive :搜索是否区分大小写。

  • maxUsageCount :返回的最大匹配条目数。

  • timeout :超时时间,单位为毫秒。

  • projectPath :项目路径。 如已知该值,请务必提供,以减少调用歧义。 如果仅知道当前工作目录,可将其作为项目路径使用。

search_in_files_by_text

使用 IntelliJ 的搜索引擎在项目的所有文件中搜索文本子串。 优先使用此工具而不是通过命令行工具读取文件,因为速度更快。

结果中的匹配项将用 || 字符包裹以突出显示。 例如 some text ||substring|| text

参数:

  • searchText :要搜索的文本子串。

  • directoryToSearch :相对于项目根目录的搜索目录。 如果未指定,将搜索整个项目。

  • fileMask :要搜索的文件掩码。 如未指定,将搜索所有文件。 示例: *.java

  • caseSensitive :搜索是否区分大小写。

  • maxUsageCount :返回的最大匹配条目数。

  • timeout :超时时间,单位为毫秒。

  • projectPath :项目路径。 如已知该值,请务必提供,以减少调用歧义。 如果仅知道当前工作目录,可将其作为项目路径使用。

get_symbol_info

检索指定文件中指定位置符号的信息。 提供与 IntelliJ IDEA 的 快速文档 功能相同的信息。 信息可能包括符号名称、签名、类型、文档及其他详细信息,具体取决于编程语言。

如果该位置引用了某个符号,且该符号声明可用,则工具将返回包含该符号声明的代码片段。 使用此工具可了解符号的声明、语义及其位置。

参数:

  • filePath :相对于项目根目录的路径。

  • line :以 1 为起点的行号。

  • column :以 1 为起点的列号。

  • projectPath :项目路径。 如已知该值,请务必提供,以减少调用歧义。 如果仅知道当前工作目录,可将其作为项目路径使用。

rename_refactoring

重命名指定文件中的符号(变量、函数、类等)。 使用此工具执行重命名重构操作。

与简单的文本查找替换不同, rename_refactoring 工具是具备代码结构感知能力的实用程序。 该工具将在整个项目中智能更新对指定符号的所有引用,确保代码完整性并避免引用断裂。 这是重命名程序符号的首选方法。

如果重命名操作成功,工具将返回成功信息;如果未找到文件或符号,或重命名失败,则返回错误信息。

参数:

  • pathInProject :相对于项目根目录的路径。

  • symbolName :要重命名的现有符号的精确、区分大小写名称(例如 getUserData)。

  • newName :符号的新精确名称,区分大小写(例如 fetchUserData)。

  • projectPath :项目路径。 如已知该值,请务必提供,以减少调用歧义。 如果仅知道当前工作目录,可将其作为项目路径使用。

execute_terminal_command

在 IDE 集成终端中执行指定的 shell 命令。 使用此工具可在 IDE 环境中运行终端命令。

主要功能和限制:

  • 在收集输出前检查进程是否正在运行。

  • 输出限制为 2000 行(多余部分将被截断)。

  • 达到指定超时后中止执行,并发出通知。

  • 除非在设置中启用 Brave Mode ,否则需要用户确认。

返回的可能响应:

  • 终端输出(如超过 2000 行将被截断)。

  • 如果命令超时,输出包含中断通知。

  • 各种失败情况的错误消息。

参数:

  • command :要执行的 shell 命令。

  • executeInShell :是否在用户默认的 shell(bash、zsh 等)中执行命令。 如果命令是 shell 脚本或需要保留用户终端的真实环境时,此选项非常有用。 如果设置为 false ,该命令将作为进程启动。

  • reuseExistingTerminalWindow :是否复用已有终端窗口,以避免创建多个终端。

  • timeout :超时时间,单位为毫秒。

  • maxLinesCount :返回的最大行数。

  • truncateMode :截断文本的方式:从开头、中间、结尾处截断,或不进行截断。

  • projectPath :项目路径。 如已知该值,请务必提供,以减少调用歧义。 如果仅知道当前工作目录,可将其作为项目路径使用。

get_repositories

获取项目中的 VCS 根列表。 使用此工具可识别多仓库项目中的所有仓库。

参数:

  • projectPath :项目路径。 如已知该值,请务必提供,以减少调用歧义。 如果仅知道当前工作目录,可将其作为项目路径使用。

最后修改日期: 2025年 9月 26日