# MCP Server

> For the complete documentation index, see [llms.txt](https://www.jetbrains.com/help/ruby/2026.3/llms.txt).

Starting with version 2025.2,  RubyMine comes with an integrated [MCP Server](https://plugins.jetbrains.com/plugin/26071-mcp-server), allowing external clients such as Claude Code, Codex, VS Code, and others to access tools provided by the IDE. This gives users the ability to control and interact with JetBrains IDEs without leaving their application of choice.

> **Tip:**
> You can find more information about the Model Context Protocol (MCP) [here](https://modelcontextprotocol.io/introduction).

Procedure: Enable the MCP Server plugin

This functionality relies on the  MCP Server plugin, which  is bundled and enabled in RubyMine   by default. If the relevant features are not available, make sure that you did not disable the plugin.

1. Press `Ctrl+Alt+S` (Windows), `⌘ Comma` (macOS), `⌘ Comma` (IntelliJ IDEA Classic (macOS)), `⌘ Comma` (macOS System Shortcuts), `Ctrl+Alt+S` (XWin), `Ctrl+Alt+S` (GNOME), `Ctrl+Alt+S` (KDE), `Ctrl+Alt+S` (Emacs), `Ctrl+Alt+S` (Sublime Text), `⌘ Comma` (Sublime Text (macOS)), `Ctrl+Alt+S` (Visual Studio), `⌘ Comma` (Visual Studio (macOS)), `Meta+Comma` (TextMate), `Ctrl+Alt+S` (NetBeans), `Ctrl+Alt+S` (Eclipse), `⌘ Comma` (Eclipse (macOS)) to open settings and then select `Plugins`.

2. Find the MCP Server plugin and click Enable.

## Enable MCP Server

To enable the MCP server, do the following:

Procedure:

1. Go to `Settings | AI | MCP Server`.

2. Select the Enable MCP Server checkbox.

3. In the Enable MCP Server? dialog, review what access third-party applications will get to the projects opened in the IDE, and click Enable to continue.

4. Click Apply.

Once the MCP server is enabled, you can proceed to configure external clients.

## External client setup

For detected external clients like Junie, VS Code, Claude Code, Codex, Air, and GitHub Copilot CLI, configuration can be performed automatically. Setting up a client means adding the address of the IDE MCP server to that client's configuration file.

To do this:

Procedure:

1. Go to `Settings | AI | MCP Server`.

2. In the Clients Auto-Configuration section, click Auto-Configure for each client you want to set up for use with the MCP server. This updates the client's configuration file automatically. The set of configured transports depends on the client.

![MCP Server settings](https://resources.jetbrains.com/help/img/idea/2026.3/ai_mcp_server_settings.png)

To configure a specific transport yourself, click ![](https://resources.jetbrains.com/help/img/idea/2026.3/app-client.expui.general.chevronDownLarge.svg) next to Auto-Configure and select the required option from the list.

![Configuration options](https://resources.jetbrains.com/help/img/idea/2026.3/ai_mcp_server_config_options.png)

> **Tip:**
> The same menu provides two more options:
>
>
>
> * Open Client Settings File opens the client's configuration file in the editor.
>
> * Copy Config copies the configuration to the clipboard so that you can apply it manually.

3. Restart your client for the configuration to take effect.

## Project-level client setup

Some clients also read a configuration file from the project's working directory. For these clients, the IDE can write the connection settings directly to the configuration file in the currently opened project, so the MCP server is available only while you work on that project.

Use this option if you work with several projects and do not want the MCP server registered for every client session.

Procedure:

1. Go to `Settings | AI | MCP Server`.

2. In the Project Clients Auto-Configuration section, click Auto-Configure for each client you want to set up. This updates the client's project-level configuration file automatically.

![Autoconfigure client's project-level configuration](https://resources.jetbrains.com/help/img/idea/2026.3/ai_mcp_server_project_level_setup.png)

If you want to configure a specific transport mechanism, click ![](https://resources.jetbrains.com/help/img/idea/2026.3/app-client.expui.general.chevronDownLarge.svg) next to Auto-Configure and select the required option from the list.

3. Restart your client for the configuration to take effect.

## Manual client setup

If the client you want to connect is not on the list, configure it manually.

Procedure:

1. In the Manual Client Configuration section, click either Copy SSE Config, Copy Stdio Config, or Copy HTTP Stream Config depending on the connection type.

![MCP Server manual configuration](https://resources.jetbrains.com/help/img/idea/2026.3/ai_mcp_server_manual_config.png)

2. Paste the copied configuration into your client's settings or configuration file.

3. Restart your client for the configuration to take effect.

## Execute actions without confirmation

The MCP server allows connected external clients to execute terminal commands or run configurations in the IDE without prompting for user confirmation each time.

To enable this mode:

Procedure:

1. Go to `Settings | AI | MCP Server`.

2. In the Command execution section, enable the Run shell commands or run configurations without confirmation (brave mode) setting.

3. Click Apply.

## Show setup suggestions in terminal sessions

When Codex or Claude starts in a terminal session without a matching MCP server setup, the IDE can show a banner that suggests configuring the connection.

To control this behavior:

Procedure:

1. Go to `Settings | AI | MCP Server`.

2. In the Terminal Sessions section, select or clear the Show setup suggestions for Codex and Claude terminal sessions checkbox.

3. Click Apply.

## Supported tools

> **Tip:**
> To skip over to the Rails-specific tools, click [here](#rails-specific-tools).

The MCP Server exposes a set of tools that allow external clients to interact with your IDE and project – for example, to analyze code, modify files, run configurations, or execute terminal commands.

You can view and manage the full list of available tools in `Settings | AI | MCP Server | Exposed Tools`. For each tool, select or clear the Enabled checkbox to control whether the tool is exposed to external clients.

![The Exposed Tools settings page](https://resources.jetbrains.com/help/img/idea/2026.3/ai_mcp_server_exposed_tools.png)

You can also select the Router-only checkbox for a tool. Router-only tools are hidden from the direct MCP tool list and remain available only through the dedicated router [tool](#universal-toolset). This keeps unnecessary tool descriptions out of the tool list and saves context. Use the Enable router-only mode for setting to specify when router-only mode applies, for example, for All agents, or ACP agents only.

> **Tip:**
> When a tool is available only through the router, describe it in skills or other agent documentation so that agents know when to use it.

Below you can find the list of tools provided by the MCP server.

### Analysis tools

analyze_calls
: Builds the IDE Call Hierarchy tree for a method, function, constructor, or supported type target. Use it to see who calls a symbol (`INCOMING_CALLS`) or what the symbol calls (`OUTGOING_CALLS`).
:
:
:
: Prefer this tool over usage search, text search, or regex search when evaluating dependencies by actual calls. It uses IDE call hierarchy data, so it provides more precise call relationships with less noise and fewer follow-up calls than primitive searches.
:
:
:
: Pass `symbolFqn` as a fully qualified name, for example `com.example.Service.run`. If the name is ambiguous, the tool returns exact signatures; pass one of them back as `symbolFqn`. If you only know a short name or fragment, use `search_symbol` first to find the target.
:
:
:
: The result is an expandable text tree. Each node includes `filePath` and `treePath`; `filePath` is project-relative when possible. Pass `treePath` back to render the subtree. Use `childOffset` to continue after a truncated … and n more line. `depth`, `maxChildren`, and `maxNodes` bound the rendered tree. Symbols can come from project sources, source jars, or decompiled binary jar dependencies when the IDE can resolve them.
:
:
:
: Parameters:
:
:
:
: * `symbolFqn` (required): Plain fully qualified symbol name, or an exact signature returned by an ambiguity error or copied from a rendered child node. If you only know a short name or fragment, use `search_symbol` first and pass the best fully qualified callable name here. Examples: `com.example.Service.run`, `com.example.Service.run(String)`, or `org.assertj.core.api.Assertions.assertThat(String)`. Do not pass a file path, line, column, or a separate target signature.
:
: * `analysisKind` (required): Call analysis direction. Use `INCOMING_CALLS` to show callers of `symbolFqn`, or `OUTGOING_CALLS` to show symbols called from `symbolFqn`.
:
: * `depth`: Maximum number of call levels to render below the requested subtree root. Defaults to 5. Use 0 to render only the subtree root.
:
: * `maxChildren`: Maximum number of direct children rendered for each node. Defaults to 50.
:
: * `maxNodes`: Maximum total number of rendered call nodes. Defaults to 1000.
:
: * `treePath`: Optional path to a subtree root, copied exactly from a previous `analyze_calls` result. Null or omitted means the root path `[]`. Each component is an exact signature, not a display name.
:
: * `childOffset`: Offset for paging direct children of the node addressed by `treePath`. Defaults to 0.
:
: * `timeout`: Timeout in milliseconds.
:
: * `projectPath`: The project path. Always provide this value if known to reduce ambiguous calls. If only the current working directory is known, you can use it as the project path.

build_project
: Triggers building of the project or specified files, waits for completion, and returns build errors. Use this tool to build the project or compile files and get detailed information about compilation errors and warnings.
:
:
:
: You have to use this tool after performing edits to validate if the edits are valid.
:
:
:
: Parameters:
:
:
:
: * `rebuild`: Whether to perform a full rebuild of the project. Defaults to false. Effective only when `filesToRebuild` is not specified.
:
: * `filesToRebuild`: If specified, only compile files with the specified paths. Paths are relative to the project root.
:
: * `timeout`: Timeout in milliseconds.
:
: * `projectPath`: The project path. Always provide this value if known to reduce ambiguous calls. If only the current working directory is known, you can use it as the project path.

get_file_problems
: Analyzes the specified file for errors and warnings using IntelliJ inspections. Use this tool to identify coding issues, syntax errors, and other problems in a specific file.
:
:
:
: Returns a list of problems, including severity, description, and location information.
:
:
:
: > **Note: Notes**
: > * Only files within the project directory can be analyzed.
: >
: > * Line and column numbers are 1-based.
:
:
:
: Parameters:
:
:
:
: * `filePath`: Path relative to the project root.
:
: * `errorsOnly`: Whether to include only errors or both errors and warnings.
:
: * `timeout`: Timeout in milliseconds.
:
: * `projectPath`: The project path. Always provide this value if known to reduce ambiguous calls. If only the current working directory is known, you can use it as the project path.

get_project_dependencies
: Returns a list of all dependencies defined in the project. Provides structured information about library names.
:
:
:
: Parameters:
:
:
:
: * `projectPath`: The project path. Always provide this value if known to reduce ambiguous calls. If only the current working directory is known, you can use it as the project path.

get_project_modules
: Returns a list of all modules in the project with their types. Provides structured information about each module, including its name and type.
:
:
:
: Parameters:
:
:
:
: * `projectPath`: The project path. Always provide this value if known to reduce ambiguous calls. If only the current working directory is known, you can use it as the project path.

lint_files
: Analyzes the specified files for errors and warnings using IntelliJ inspections. Use this tool to lint several files after editing them. Returns per-file problems with severity, description, and location information.
:
:
:
: Batch responses may include file entries with `timedOut: true` and empty `problems` when individual files exceed the available budget. File entries with a `notAnalyzedReason` indicate files that could not be analyzed, for example files outside project content roots, excluded files, or unsupported file types. A top-level `more: true` means the batch is incomplete.
:
:
:
: > **Note: Notes**
: > * Only files within the project directory are analyzed.
: >
: > * Line and column numbers are 1-based.
:
:
:
: Parameters:
:
:
:
: * `files` (required): List of project-relative files to analyze. Duplicate paths are ignored after normalization.
:
: * `min_severity`: Minimum severity to include: `warning` or `error`. Defaults to `warning`.
:
: * `timeout`: Timeout in milliseconds.
:
: * `projectPath`: The project path. Always provide this value if known to reduce ambiguous calls. If only the current working directory is known, you can use it as the project path.

### Code Insight tools

get_symbol_info
: Retrieves information about the symbol at the specified position in the specified file. Provides the same information as IntelliJ IDEA's Quick Documentation feature. The information may include the symbol's name, signature, type, documentation, and other details, depending on the programming language.
:
:
:
: If the position references a symbol, the tool will return a code snippet with the symbol's declaration, if available. Use this tool to understand a symbol's declaration, semantics, and location.
:
:
:
: Parameters:
:
:
:
: * `filePath`: Path relative to the project root.
:
: * `line`: 1-based line number.
:
: * `column`: 1-based column number.
:
: * `projectPath`: The project path. Always provide this value if known to reduce ambiguous calls. If only the current working directory is known, you can use it as the project path.

### Database-specific tools

> **Note:**
> This functionality relies on the [Database Tools and SQL](https://plugins.jetbrains.com/plugin/10925-database-tools-and-sql-for-webstorm--rustrover)  plugin, which   you need to install and enable.   For more information, refer to [Open plugin settings](managing-plugins.html#open-plugin-settings).

To guarantee strictly read-only access for an AI agent, use a database user with properly restricted (read-only) privileges and configure the data source to use that user.

cancel_sql_query
: Cancel a running query using its unique ID.
:
:
:
: Parameters:
:
:
:
: * `sessionId`: Query session ID.

create_database_connection
: Creates a new database connection (data source) by name, DBMS (`dbms`), JDBC URL (`url`), and a flag to check the connection (`needToCheckDs`). All parameters are required. Returns connection diagnostic information.
:
:
:
: Parameters:
:
:
:
: * `name` (required): Unique name of the database connection.
:
: * `dbms`: Name of the database management system (DBMS).
:
: * `url`: Fully formed JDBC URL of the database connection, for example `jdbc:postgresql://<host>:<port>/<database>`.
:
: * `needToCheckDs`: Whether to test the connection right after the data source is created or edited. Set to `false` when configuring multiple connections in a batch — the per-connection probe is expensive, and `test_database_connection` can be called explicitly for the connections that matter.
:
: * `projectPath`: The project path. Always provide this value if known to reduce ambiguous calls. If only the current working directory is known, you can use it as the project path.

edit_database_connection
: Edits an existing database connection (data source) identified by `connectionId`. Updates the connection's DBMS driver and JDBC URL; the connection `name` is preserved. Returns connection diagnostic information.
:
:
:
: > **Note:**
: > Do not use this tool for DDL data sources, as they have no underlying DBMS connection.
:
:
:
: Parameters:
:
:
:
: * `connectionId`: Unique connection ID.
:
: * `dbms`: Name of the database management system (DBMS).
:
: * `url`: Fully formed JDBC URL of the database connection, for example `jdbc:postgresql://<host>:<port>/<database>`.
:
: * `needToCheckDs`: Whether to test the connection right after the data source is created or edited. Set to `false` when configuring multiple connections in a batch — the per-connection probe is expensive, and `test_database_connection` can be called explicitly for the connections that matter.
:
: * `projectPath`: The project path. Always provide this value if known to reduce ambiguous calls. If only the current working directory is known, you can use it as the project path.

execute_sql_query
: Execute a SQL query against the given database connection.
:
:
:
: The tool reports execution status: success or error. For errors, it also provides an error description.
:
:
:
: If the query returns data, it is appended to the tool response in CSV format.
:
:
:
: Parameters:
:
:
:
: * `connectionId`: Unique connection ID.
:
: * `queryText`: SQL query to be executed.

fetch_query_result
: Fetches rows from an already executed query by its ID, starting at the given row offset. Returns the same shape as `execute_sql_query`: the `resultSetId` and the rendered result in CSV format.
:
:
:
: Use this tool to paginate over a `resultSetId` previously returned by `execute_sql_query` or `preview_table_data`.
:
:
:
: Parameters:
:
:
:
: * `resultSetId` (required): The opaque result-set ID returned by a previous `execute_sql_query` or `preview_table_data` call.
:
: * `offset` (required): Row offset to start fetching from. Defaults to 0.
:
: * `projectPath`: The project path. Always provide this value if known to reduce ambiguous calls. If only the current working directory is known, you can use it as the project path.

get_database_object_description
: Retrieves the structure of a database object (columns, types, keys, indexes) within a particular schema as a hierarchical text representation.
:
:
:
: In case of ambiguity returns definitions of all applicable objects.
:
:
:
: Parameters:
:
:
:
: * `connectionId`: Unique connection ID.
:
: * `databaseName`: Name of the database the schema belongs to. Can be empty if the DBMS has no databases but only schemas.
:
: * `schemaName`: Name of the schema.
:
: * `kind`: Set this parameter to a particular object kind code to list only objects of that kind. Set it to null to retrieve all objects in the schema.
:
: * `objectName`: Object name of the specified kind (e.g., table or view name). May not be empty.
:
: * `projectPath`: The project path. Always provide this value if known to reduce ambiguous calls. If only the current working directory is known, you can use it as the project path.

introspect_schema
: Introspects a database schema, loading its metadata (tables, columns, and indexes) into the local model. Use this when a schema's `isIntrospected` flag is false and you need to investigate the schema's structure, or to refresh stale metadata. Returns the schema identifier with the updated introspection status.
:
:
:
: Parameters:
:
:
:
: * `connectionId`: Unique connection ID.
:
: * `databaseName`: Name of the database the schema belongs to. Can be empty if the DBMS has no databases but only schemas.
:
: * `schemaName`: Name of the schema.
:
: * `projectPath`: The project path. Always provide this value if known to reduce ambiguous calls. If only the current working directory is known, you can use it as the project path.

list_database_connections
: Retrieves a list of configured database connections or data sources in the project. For each connection returns its unique ID, name, DBMS, and driver name.

list_database_schemas
: Retrieves a list of database schemas in the specified database connection.
:
:
:
: For each schema, the tool returns the schema's own name as well as the database name (empty if not applicable).
:
:
:
: Parameters:
:
:
:
: * `connectionId`: Unique connection ID.
:
: * `selectedOnly`: True if only the schemas selected in the database tree should be listed; false if all schemas should be listed.

list_recent_sql_queries
: This feature is not available in free subscription plans.
:
:
:
: Retrieves a list of recent, including currently running, queries for the given database connection.
:
:
:
: For each query returns:
:
:
:
: * Unique ID of a query session.
:
: * Time spent on running the query (in milliseconds).
:
: * The current state of the query. For example, running, cancelling, finished, and so on.
:
: * Completion status of the query. For example, success, finished with error, cancelled, and so on.
:
: * Text of the query.
:
:
:
: Parameters:
:
:
:
: * `connectionId`: Unique connection ID.

list_schema_object_kinds
: Retrieves a list of supported schema object kinds for the given database connection. For each object kind, returns the object kind unique code and human-readable name.
:
:
:
: Parameters:
:
:
:
: * `connectionId`: Unique connection ID.

list_schema_objects
: Retrieves a list of database objects within the given schema. For each object, returns the object name within the schema and its kind.
:
:
:
: Parameters:
:
:
:
: * `connectionId`: Unique connection ID.
:
: * `schemaName`: Name of the schema.
:
: * `databaseName`: Name of the database the schema belongs to. Can be empty if the DBMS has no databases but only schemas.
:
: * `kind`: Set this parameter to a particular object kind code to list only objects of that kind. Set it to null to retrieve all objects in the schema.

preview_table_data
: Returns preview data of the table, view, materialized view, or other table-like object using a given database connection.
:
:
:
: The tool returns table content in CSV format.
:
:
:
: Parameters:
:
:
:
: * `connectionId`: Unique connection ID.
:
: * `schemaName`: Name of the schema.
:
: * `databaseName`: Name of the database the schema belongs to. Can be empty if the DBMS has no databases but only schemas.
:
: * `tableName`: Name of the table.
:
: * `maxRowCount`: Maximum number of rows to return. Default is `100`.

test_database_connection
: Returns connection diagnostic info:
:
:
:
: * Flag indicating if the connection is problematic: yes, no, or unknown.
:
: * Detailed information about the database connection such as DBMS type, version, and JDBC driver.
:
: * Summary of the connection attempt result. In case of a failure, contains a DBMS-provided error description.
:
:
:
: Parameters:
:
:
:
: * `id`: Unique connection ID.

### Execution tools

execute_run_configuration
: Run either an existing run configuration by name or a temporary run configuration created from a code location (`filePath` + `line`) in the current project, then wait up to the specified timeout for it to finish. Use this tool with either a configuration name returned by `[get_run_configurations](#get_run_configurations)`, or with a run point (`filePath` + `line`) returned by `get_run_configurations(filePath = ...)`.
:
:
:
: Optional launch overrides (`programArguments`, `workingDirectory`, `envs`) are applied only for this run and are not persisted. Do not pass these override parameters unless you explicitly need to change the configured launch values for this run. Missing/null override parameters keep existing run configuration values unchanged. For string overrides (`programArguments`, `workingDirectory`), missing/null or empty string (`""`) keeps the existing value unchanged. Pass a whitespace-only string such as `" "` to clear an existing value for this launch.
:
:
:
: Pass either `configurationName`, or `filePath` together with `line`. These modes are mutually exclusive.
:
:
:
: Behavior:
:
:
:
: * When `waitForExit=true`, waits up to `timeout` milliseconds for process termination. If the timeout expires, the process keeps running in the background and `exitCode` is omitted from the result.
:
: * When `waitForExit=false`, waits only for the process to start, then returns immediately without applying `timeout`.
:
: * `fullOutputPath` points to a temp file with the full raw output and may continue growing while the process is alive.
:
:
:
: Returns the execution result including current output snapshot, optional exit code, and optional `fullOutputPath`.
:
:
:
: Parameters:
:
:
:
: * `configurationName`: Name of the existing run configuration to execute.
:
: * `filePath`: File path relative to the project root. Provide together with `line` to create and execute a temporary run configuration from code context.
:
: * `line`: 1-based line number for `filePath`. Provide together with `filePath` and do not combine with `configurationName`.
:
: * `timeout`: Timeout in milliseconds.
:
: * `waitForExit`: Whether to wait for process termination. If false, the tool returns immediately after the process starts and ignores `timeout`.
:
: * `programArguments`: Optional program arguments override for this launch only. Missing/null or empty string keeps the existing value; whitespace-only string clears it.
:
: * `workingDirectory`: Optional working directory override for this launch only. Missing/null or empty string keeps the existing value; whitespace-only string clears it.
:
: * `envs`: Optional environment variable overrides for this launch only. Missing/null keeps existing env unchanged; when provided, values are merged over existing env.
:
: * `projectPath`: The project path. Always provide this value if known to reduce ambiguous calls. If only the current working directory is known, you can use it as the project path.

get_run_configurations
: Returns either project run configurations or executable code locations, depending on the input.
:
:
:
: Without `filePath`, this tool lists the project's existing run configurations. The result includes configuration names and, when available, launch details such as program arguments, working directory, environment variables, and `supportsDynamicLaunchOverrides`.
:
:
:
: `supportsDynamicLaunchOverrides` is the source-of-truth capability flag for one-time launch overrides (`programArguments`, `workingDirectory`, `envs`) in `[execute_run_configuration](#execute_run_configuration)` and `[xdebug_start_debugger_session](null)`. Only pass those override parameters when this flag is `true` for the selected configuration.
:
:
:
: With `filePath`, this tool discovers executable entry points (run points) in that file, such as test methods, main methods, or other executable entry points where the IDE shows a Run gutter icon. The result contains `filePath` and `runPoints`; use the returned line numbers with `[execute_run_configuration](#execute_run_configuration)` to run from code.
:
:
:
: Parameters:
:
:
:
: * `filePath`: Optional file path relative to the project root. When provided, returns run points (executable entry points) in the file instead of project-wide run configurations.
:
: * `projectPath`: The project path. Always provide this value if known to reduce ambiguous calls. If only the current working directory is known, you can use it as the project path.

### File tools

create_new_file
: Creates a new file at the specified path within the project directory. Optionally, writes the provided text into the file.
:
:
:
: > **Note:**
: > Any required parent directories are created automatically.
:
:
:
: Parameters:
:
:
:
: * `pathInProject`: Path where the file should be created relative to the project root.
:
: * `text` (optional): Content to write into the new file.
:
: * `overwrite`: Whether to overwrite an existing file. If set to `false`, an exception is thrown in case of a conflict.
:
: * `projectPath`: The project path. Always provide this value if known to reduce ambiguous calls. If only the current working directory is known, you can use it as the project path.

get_all_open_file_paths
: Returns the paths of all files opened for editing in the active editor or any other open editors, relative to the project root. Use this tool to explore currently open editors.
:
:
:
: Parameters:
:
:
:
: * `projectPath`: The project path. Always provide this value if known to reduce ambiguous calls. If only the current working directory is known, you can use it as the project path.

list_directory_tree
: Provides a tree representation of the specified directory in the pseudo-graphic format, similar to the `tree` utility. Use this tool to explore the contents of a directory or the entire project. Prefer this tool over command-line utilities like `ls` or `dir` for directory listing.
:
:
:
: Parameters:
:
:
:
: * `directoryPath`: Path relative to the project root.
:
: * `maxDepth`: Maximum recursion depth.
:
: * `timeout`: Timeout in milliseconds.
:
: * `projectPath`: The project path. Always provide this value if known to reduce ambiguous calls. If only the current working directory is known, you can use it as the project path.

open_file_in_editor
: Opens the specified file in the JetBrains IDE editor. Requires a `filePath` parameter containing the path to the file to open. The file path can be absolute or relative to the project root.
:
:
:
: Parameters:
:
:
:
: * `filePath`: Path relative to the project root.
:
: * `projectPath`: The project path. Always provide this value if known to reduce ambiguous calls. If only the current working directory is known, you can use it as the project path.

### Formatting tools

reformat_file
: Reformats the specified file in the JetBrains IDE. Use this tool to apply code formatting to a file identified by its path.
:
:
:
: Parameters:
:
:
:
: * `path`: Path relative to the project root.
:
: * `projectPath`: The project path. Always provide this value if known to reduce ambiguous calls. If only the current working directory is known, you can use it as the project path.

### Inspection Generator MCP Tools

validate_inspection_kts
: Validates an `inspection.kts` script against specification examples. Compiles the inspection and runs it against positive/negative examples. Returns compilation status and detailed verification results.
:
:
:
: Positive examples should trigger the inspection (problems expected). Negative examples should NOT trigger the inspection (no problems expected on forbidden lines).
:
:
:
: Returns overall success, per-example results, and aggregation statistics.
:
:
:
: Parameters:
:
:
:
: * `inspectionKtsCode`: The `inspection.kts` script content to compile and validate.
:
: * `pathToSpecification`: Path to specification with examples to validate against.
:
: * `projectPath`: The project path. Always provide this value if known to reduce ambiguous calls. If only the current working directory is known, you can use it as the project path.

### Inspection KTS MCP tools

generate_inspection_kts_api
: Returns the Inspection KTS API documentation for the target language. Provides available classes and functions that can be used when writing `inspection.kts` files.
:
:
:
: Parameters:
:
:
:
: * `language`: Target language: 'Java' or 'Kotlin'.
:
: * `wrapInTags`: If true, wraps the API content in `<API>` and `<api.kt>` tags.
:
: * `projectPath`: The project path. Always provide this value if known to reduce ambiguous calls. If only the current working directory is known, you can use it as the project path.

generate_inspection_kts_examples
: Returns example `inspection.kts` templates for the target language to guide code generation. Provides XML-wrapped examples showing how to write inspections using the InspectionKts API.
:
:
:
: Parameters:
:
:
:
: * `language`: Target language: 'Java' or 'Kotlin'.
:
: * `includeAdditionalExamples`: If true, includes additional curated examples besides templates.
:
: * `projectPath`: The project path. Always provide this value if known to reduce ambiguous calls. If only the current working directory is known, you can use it as the project path.

generate_psi_tree
: Creates a PSI tree for the provided Java or Kotlin code and returns it as indented text. Use this tool to understand the PSI structure of code snippets when writing inspections. The output shows element types and their hierarchy, with hints about when `node.children()` is needed.
:
:
:
: Parameters:
:
:
:
: * `code`: Source code snippet to parse.
:
: * `language`: Target language: 'Java' or 'Kotlin'.
:
: * `projectPath`: The project path. Always provide this value if known to reduce ambiguous calls. If only the current working directory is known, you can use it as the project path.

run_inspection_kts
: Compiles an `inspection.kts` script and runs it against a target file. Returns compilation errors if any, or the list of problems found by the inspection. Use this tool to test `inspection.kts` scripts during development.
:
:
:
: Parameters:
:
:
:
: * `inspectionKtsCode`: The `inspection.kts` script content to compile and run.
:
: * `contextPath`: Relative path of the target file inside project to analyze (for example, `src/my/package/Example.kt`).
:
: * `targetFileContent`: The content of the target file to analyze. If not provided, the file must exist in the project.
:
: * `projectPath`: The project path. Always provide this value if known to reduce ambiguous calls. If only the current working directory is known, you can use it as the project path.

### Patch tools

apply_patch
: Applies a patch in the Codex `apply_patch` format or the unified Git diff format. Supports Add, Delete, and Update operations, with an optional move-to path for updates. Paths must stay inside the project directory.
:
:
:
: Parameters:
:
:
:
: * `input`: Patch text in the `apply_patch` format or the unified Git diff format.
:
: * `patch`: Alias of `input` for compatibility with clients that send `{patch: ...}`.
:
: * `projectPath`: The project path. Always provide this value if known to reduce ambiguous calls. If only the current working directory is known, you can use it as the project path.

### Read tools

read_file
: Reads a file in the project directory or from any project dependency or other project source root. Can read sources inside Jar/Jrt files and decompile Java class files inside Jar/Jrt files or on disk. Returns numbered lines (1-indexed) as text.
:
:
:
: Modes:
:
:
:
: * `slice`
:
: * `lines`
:
: * `line_columns`
:
: * `offsets`
:
: * `indentation`
:
:
:
: Mode details:
:
:
:
: * `slice` uses `start_line` and `max_lines`.
:
: * `lines` uses `start_line`/`end_line` (inclusive).
:
: * `line_columns` uses `start_line`/`start_column` and `end_line`/`end_column` (`end` is exclusive; `end_line` defaults to `start_line`).
:
: * `offsets` uses `start_offset`/`end_offset` (`end` is exclusive).
:
: * `indentation` uses `start_line` with `max_levels`/`include_*`.
:
:
:
: `max_lines` caps the total output in all modes; `context_lines` applies to range modes (per side).
:
:
:
: Parameters:
:
:
:
: * `file_path`: Path to the file. Supports project-relative paths, paths with `'..'`, absolute paths, archive entries like `/path/lib.jar!/pkg/Foo .class`, and URLs such as `file://`, `jar://`, and `jrt://`. Any path returned from the other tools can be passed as is (e.g. paths from `search_*` tools).
:
: * `mode`: Read mode: `slice`, `lines`, `line_columns`, `offsets`, or `indentation`.
:
: * `start_line`: 1-based line number to start reading from.
:
: * `max_lines`: Maximum number of lines to return (slice uses as line count; all modes cap output).
:
: * `end_line`: 1-based end line for `lines`/`line_columns` mode (inclusive for `lines`; exclusive for `line_columns`).
:
: * `start_column`: 1-based start column for `line_columns` mode.
:
: * `end_column`: 1-based end column for range read (exclusive).
:
: * `start_offset`: 0-based start offset for offsets mode (requires `end_offset`).
:
: * `end_offset`: 0-based end offset for offsets mode (exclusive).
:
: * `context_lines`: Number of context lines to include around the range (per side).
:
: * `max_levels`: Indentation mode: maximum indentation levels to include (0 = only anchor block).
:
: * `include_siblings`: Indentation mode: include sibling blocks at the same indentation level.
:
: * `include_header`: Indentation mode: include header comments/annotations directly above anchor.
:
: * `projectPath`: The project path. Always provide this value if known to reduce ambiguous calls. If only the current working directory is known, you can use it as the project path.

### Refactoring tools

rename_refactoring
: Renames a symbol (variable, function, class, etc.) in the specified file. Use this tool to perform rename refactoring operations.
:
:
:
: Unlike a simple text search-and-replace, the `rename_refactoring` tool is a context-aware utility that understands the code's structure. It intelligently updates all references to the specified symbol throughout the project, ensuring code integrity and preventing broken references. It is always the preferred method for renaming programmatic symbols.
:
:
:
: The tool returns a success message if the rename operation was successful, or an error message if the file or symbol cannot be found, or if the rename operation fails.
:
:
:
: Parameters:
:
:
:
: * `pathInProject`: Path relative to the project root.
:
: * `symbolName`: Name of the symbol to rename.
:
: * `newName`: New name for the symbol.
:
: * `projectPath`: The project path. Always provide this value if known to reduce ambiguous calls. If only the current working directory is known, you can use it as the project path.

### Search tools

search_file
: Searches for files by glob pattern within the project. Use this tool when you need to match file paths using glob syntax.
:
:
:
: Glob patterns are relative to the project root.
:
:
:
: Examples:
:
:
:
: * `"**/*.kt"`
:
: * `"src/**/Foo*.java"`
:
: * `"build.gradle.kts"`
:
:
:
: Patterns without `'/'` are treated as `"**/pattern"`. `paths` are optional additional glob filters relative to the project root.
:
:
:
: Parameters:
:
:
:
: * `q`: Glob pattern to search for.
:
: * `paths`: Optional list of project-relative glob patterns to filter results. Supports `!` excludes. Trailing `/` expands to `**`. Patterns without `/` are treated as `**/pattern`. Empty strings are ignored.
:
: * `includeExcluded`: Whether to include excluded/ignored files in results.
:
: * `limit`: Maximum number of results to return.
:
: * `projectPath`: The project path. Always provide this value if known to reduce ambiguous calls. If only the current working directory is known, you can use it as the project path.

search_regex
: Searches for regex matches within project files. Use this tool when you need regex search with snippet results. Results include match coordinates when available (1-based line/column, 0-based offsets).
:
:
:
: Paths are glob patterns relative to the project root.
:
:
:
: Examples:
:
:
:
: * `["src/**", "!**/test/**"]`
:
: * `["**/*.kt"]`
:
: * `["foo/"]`
:
:
:
: Parameters:
:
:
:
: * `q`: Regex pattern to search for.
:
: * `paths`: Optional list of project-relative glob patterns to filter results. Supports `!` excludes. Trailing `/` expands to `**`. Patterns without `/` are treated as `**/pattern`. Empty strings are ignored.
:
: * `limit`: Maximum number of results to return.
:
: * `projectPath`: The project path. Always provide this value if known to reduce ambiguous calls. If only the current working directory is known, you can use it as the project path.

search_symbol
: Searches for symbols (classes, methods, fields). Use this tool for semantic lookup by identifier fragments. Results include match coordinates when available (1-based line/column, 0-based offsets).
:
:
:
: Paths are glob patterns relative to the project root.
:
:
:
: By default, this searches project symbols only. If you don't find a suitable result, try again with `include_external=true` to search SDK and library symbols too.
:
:
:
: Parameters:
:
:
:
: * `q`: Symbol query text.
:
: * `paths`: Optional list of project-relative glob patterns to filter results. Supports `!` excludes. Trailing `/` expands to `**`. Patterns without `/` are treated as `**/pattern`. Empty strings are ignored.
:
: * `include_external`: Whether to include SDK and library symbols. Disabled by default; if nothing suitable is found, try again with `include_external=true`.
:
: * `limit`: Maximum number of results to return.
:
: * `projectPath`: The project path. Always provide this value if known to reduce ambiguous calls. If only the current working directory is known, you can use it as the project path.

search_text
: Searches for a text substring within project files. Use this tool for fast text search with snippet results. Results include match coordinates when available (1-based line/column, 0-based offsets).
:
:
:
: Paths are glob patterns relative to the project root.
:
:
:
: Examples:
:
:
:
: * `["src/**", "!**/test/**"]`
:
: * `["**/*.kt"]`
:
: * `["foo/"]`
:
:
:
: Parameters:
:
:
:
: * `q`: Text to search for.
:
: * `paths`: Optional list of project-relative glob patterns to filter results. Supports `!` excludes. Trailing `/` expands to `**`. Patterns without `/` are treated as `**/pattern`. Empty strings are ignored.
:
: * `limit`: Maximum number of results to return.
:
: * `projectPath`: The project path. Always provide this value if known to reduce ambiguous calls. If only the current working directory is known, you can use it as the project path.

### Skill Search tools

skill_search
: Performs a unified project search with an explicit mode:
:
:
:
: * `file`: glob path search.
:
: * `text`: literal content search.
:
: * `regex`: regex content search.
:
: * `symbol`: semantic symbol lookup.
:
:
:
: Symbol search is project-focused by default. If you do not find a suitable symbol, try again with `include_external=true` to search SDK and library symbols too.
:
:
:
: Parameters:
:
:
:
: * `mode` (required): Search mode: `file`, `text`, `regex`, or `symbol`.
:
: * `q` (required): Search query. For `mode=file` this is a glob pattern.
:
: * `paths`: Optional project-relative glob filters. Supports `!`-excludes and a trailing `/`.
:
: * `include_external`: Whether to include SDK and library symbols for `mode=symbol`. Disabled by default; if nothing suitable is found, try again with `include_external=true`.
:
: * `includeExcluded`: Whether to include excluded or ignored files. Supported only for `mode=file`.
:
: * `limit`: Maximum number of results to return.
:
: * `projectPath`: The project path. Always provide this value if known to reduce ambiguous calls. If only the current working directory is known, you can use it as the project path.

### Terminal tools

execute_terminal_command
: Executes a specified shell command in the IDE's integrated terminal. Use this tool to run terminal commands within the IDE environment.
:
:
:
: Important features and limitations:
:
:
:
: * Checks if a process is running before collecting output.
:
: * Limits output to 2000 lines (truncates any excess).
:
: * Times out after the specified timeout, with a notification.
:
: * Requires user confirmation unless [Brave Mode](#execute-actions-without-confirmation) is enabled in the settings.
:
:
:
: Returns possible responses:
:
:
:
: * Terminal output (truncated if over 2000 lines).
:
: * Output with an interruption notice if the command times out.
:
: * Error messages for various failure cases.
:
:
:
: Parameters:
:
:
:
: * `command`: Shell command to execute.
:
: * `executeInShell`: Whether to execute the command in the user's default shell (bash, zsh, etc.). Useful if the command is a shell script or if it is important to preserve the real environment of the user's terminal. If set to `false`, the command will be started as a process.
:
: * `reuseExistingTerminalWindow`: Whether to reuse an existing terminal window to avoid creating multiple terminals.
:
: * `timeout`: Timeout in milliseconds.
:
: * `maxLinesCount`: Maximum number of lines to return.
:
: * `truncateMode`: How to truncate the text: from the start, in the middle, at the end, or do not truncate at all.
:
: * `projectPath`: The project path. Always provide this value if known to reduce ambiguous calls. If only the current working directory is known, you can use it as the project path.

### Universal tools

execute_tool
: Universal tool executor that dynamically invokes a specific IDE MCP tool from a command-line string.
:
:
:
: Parameters:
:
:
:
: * `command` (required): Command-line string with the tool name and arguments.
:
: * `projectPath`: The project path. Always provide this value if known to reduce ambiguous calls. If only the current working directory is known, you can use it as the project path.

### VCS tools

get_repositories
: Retrieves the list of VCS roots in the project. Use this tool to identify all repositories in a multi-repository project.
:
:
:
: Parameters:
:
:
:
: * `projectPath`: The project path. Always provide this value if known to reduce ambiguous calls. If only the current working directory is known, you can use it as the project path.

git_status
: Retrieves the Git status for one or more repositories in the current project. Returns porcelain-style index and worktree status codes and summary counters. By default, all Git repositories are returned.
:
:
:
: Parameters:
:
:
:
: * `repositoryPathRelativeToProject`: Optional path relative to the project root used to select a single containing repository.
:
: * `includeUntracked`: Whether to include untracked files.
:
: * `includeIgnored`: Whether to include ignored files.
:
: * `limit`: Maximum number of entries returned per repository.
:
: * `projectPath`: The project path. Always provide this value if known to reduce ambiguous calls. If only the current working directory is known, you can use it as the project path.

### Rails-specific tools

get_rails_routes
: Retrieves Rails routes in the project. Results are returned in a paginated list and filtered based on included/excluded paths, actions (specified by fully-qualified name, or FQN), directories, and HTTP methods.
:
:
:
: Prefer this tool over manual code inspection as it performs deep analysis of Rails routes.
:
:
:
: Parameters:
:
:
:
: * `page`: Page number for pagination.
:
: * `page_size`: Number of items per page.
:
: * `included_route_path_filters`: List of route path patterns to include.
:
: * `excluded_route_path_filters`: List of route path patterns to exclude.
:
: * `included_action_fqn_filters`: List of fully-qualified action names to include.
:
: * `excluded_action_fqn_filters`: List of fully-qualified action names to exclude.
:
: * `included_action_directory_filters`: List of action directories to include.
:
: * `excluded_action_directory_filters`: List of action directories to exclude.
:
: * `min_action_count`: Minimum number of actions a route must have.
:
: * `max_action_count`: Maximum number of actions a route can have.
:
: * `included_http_method_filters`: List of HTTP methods to include (GET, POST, etc.).
:
: * `excluded_http_method_filters`: List of HTTP methods to exclude.

get_rails_models
: Retrieves Rails models in the project. Results are paginated and can be filtered by FQN
:
:
:
: Parameters:
:
:
:
: * `page`: Page number for pagination.
:
: * `page_size`: Number of items per page.
:
: * `included_fqn_filters`: List of FQN patterns to include.
:
: * `excluded_fqn_filters`: List of FQN patterns to exclude.
:
: * `included_directory_filters`: List of directories to include.
:
: * `excluded_directory_filters`: List of directories to exclude.
:
: * `controller_filter`: Filter to include only models with or without corresponding controllers.

get_rails_controllers
: Retrieves Rails controllers in the project. Results are paginated and can be filtered by FQN, directory, views, abstract status, and corresponding model presence.
:
:
:
: Parameters:
:
:
:
: * `page`: Page number for pagination.
:
: * `page_size`: Number of items per page.
:
: * `included_fqn_filters`: List of FQN patterns to include.
:
: * `excluded_fqn_filters`: List of FQN patterns to exclude.
:
: * `included_directory_filters`: List of directories to include.
:
: * `excluded_directory_filters`: List of directories to exclude.
:
: * `included_view_filters`: List of view filters to include.
:
: * `excluded_view_filters`: List of view filters to exclude.
:
: * `abstract_filter`: Filter to include only abstract, non-abstract, or all controllers.
:
: * `model_filter`: Filter to include only controllers with or without a corresponding model.

get_rails_helpers
: Retrieves Rails helpers in the project. Results are paginated and can be filtered by FQN and directory.
:
:
:
: Parameters:
:
:
:
: * `page`: Page number for pagination.
:
: * `page_size`: Number of items per page.
:
: * `included_fqn_filters`: List of FQN patterns to include.
:
: * `excluded_fqn_filters`: List of FQN patterns to exclude.
:
: * `included_directory_filters`: List of directories to include.
:
: * `excluded_directory_filters`: List of directories to exclude.

get_rails_views
: Retrieves Rails views in the project. Results are paginated and can be filtered by partiality, layout, controller association, path, and controller directory/FQN.
:
:
:
: > **Note:**
: > Filters related to controller directory/FQN apply to the controller associated with the view, not the view file itself
:
:
:
: Parameters:
:
:
:
: * `page`: Page number for pagination.
:
: * `page_size`: Number of items per page.
:
: * `partiality_filter`: Filter to include only partial views, non-partial views, or both.
:
: * `layout_filter`: Filter to include only layout views, non-layout views, or both.
:
: * `controller_filter`: Filter to include only views with associated controllers.
:
: * `included_path_filters`: List of view paths to include.
:
: * `excluded_path_filters`: List of view paths to exclude.
:
: * `included_controller_fqn_filters`: List of controller FQNs to include.
:
: * `excluded_controller_fqn_filters`: List of controller FQNs to exclude.
:
: * `included_controller_directory_filters`: List of controller directories to include.
:
: * `excluded_controller_directory_filters`: List of controller directories to exclude.

get_rails_mailers
: Retrieves Rails mailers in the project. Results are paginated and can be filtered by FQN and directory.
:
:
:
: Parameters:
:
:
:
: * `page`: Page number for pagination.
:
: * `page_size`: Number of items per page.
:
: * `included_fqn_filters`: List of FQN patterns to include.
:
: * `excluded_fqn_filters`: List of FQN patterns to exclude.
:
: * `included_directory_filters`: List of directories to include.
:
: * `excluded_directory_filters`: List of directories to exclude.

