---
title: "JetBrains plugin"
description: "Install MySpec for IntelliJ IDEA, PyCharm, WebStorm, GoLand and other JetBrains IDEs, sign in with your MySpec account and link a project."
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.myspec.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# JetBrains plugin

MySpec for JetBrains IDEs shows a project's spec files, attachments, tasks and
discussions in a **MySpec** tool window. See [MySpec in your IDE](https://docs.myspec.dev/ide/) for
what it can do and how sign-in works.

**Requirements:** IntelliJ IDEA, PyCharm, WebStorm, GoLand, PhpStorm, RubyMine,
Rider or another IntelliJ-based IDE, version 2025.3 or later. A MySpec account
in at least one organization.

## Install

1. Open **Settings** → **Plugins**.
2. Select the **Marketplace** tab and search for **MySpec**.
3. Select **MySpec** by vendor **MySpec**, then **Install**. Restart the IDE if
   it asks.

You can also install it from the
[JetBrains Marketplace page](https://plugins.jetbrains.com/plugin/35781-myspec)
with **Install to IDE**. The IDE keeps the plugin up to date like any other.

A **MySpec** tool window appears on the left, and a **MySpec** entry appears in
the status bar and under **Tools → MySpec**.

## Sign in

Open the **MySpec** tool window. If you already signed in with the
[local MCP server](https://docs.myspec.dev/mcp/local-server/) or the VS Code extension on this machine,
you are signed in already: skip to [Link a project](#link-a-project).

Otherwise the tool window shows two links. Pick one.

### Sign in with your browser

1. **Start the sign-in**

   Select **Sign in with browser** in the tool window, or choose
   **Tools → MySpec → Sign In to MySpec with Browser…**.
2. **Sign in to MySpec in your browser**

   Your browser opens the MySpec sign-in page. Sign in the way you usually do
   and approve the request. Meanwhile, the IDE shows a **MySpec Sign-In**
   dialog that says **Waiting for the MySpec sign-in in your browser…**; it
   closes on its own when you finish.
3. **Choose your organization**

   If you belong to more than one organization, the IDE may ask
   **Which MySpec Organization Should the IDE Use?** Pick one. You can switch
   later.
4. **Done**

   The IDE shows **Signed in to MySpec as** your email and organization, and
   asks you to [link a project](#link-a-project).

This sign-in is shared with the MySpec MCP server and VS Code on this machine.
If the MCP server is already signed in to a different MySpec environment, the
IDE asks **Replace the MySpec Sign-In?** first, because signing in here
replaces that sign-in too.

### Sign in with an API token

Use this on a shared machine, or when you want read-only access.

1. **Create a token**

   In [MySpec](https://app.myspec.dev), open the avatar menu and choose
   **API tokens**, then **Create token**. Choose the organization and the
   access (**Read only** or **Read and write**), then copy the token. See
   [API tokens](https://docs.myspec.dev/mcp/api-tokens/#create-a-token) for details.
2. **Enter it in the IDE**

   Select **Use an API token** in the tool window, or choose
   **Tools → MySpec → Sign In to MySpec with API Token…**. Paste the token
   (`msp_pat_…`) and select **Sign In**. The IDE checks it with MySpec before
   saving it.

The token is kept in the IDE's password safe and used only by the IDE.
It is never written to `~/.myspec/`, so it does not change what the MCP server
signs in as. While a token is saved in the IDE, the IDE uses it instead of the
browser sign-in.

### Sign in on a remote machine or another device

When the browser cannot hand the sign-in back to the IDE (the browser is on
another device, or the IDE runs on a remote host), paste it instead:

1. Start **Sign in with browser**. In the **MySpec Sign-In** dialog, select
   **Copy sign-in link** if you need to open it elsewhere.
2. Open the link in a browser and sign in.
3. The page shows a value like `<code>.<state>`. Copy **the whole value,
   including the dot**, paste it into the dialog's token field and select
   **Use Pasted Token** straight away: it expires a minute after you finish
   signing in.

> **Only open the sign-in link on a machine you trust**
>
> The sign-in page hands a one-time code to a program listening on the machine
> where the browser runs. Anything else running there could take the code and
> act as you until you sign out.

When the plugin runs on a remote host (for example with JetBrains remote
development), it uses the sign-in saved on that host, not on your laptop.
Sign in there with the steps above.

## Check who you are signed in as

The status bar shows who is signed in and the organization. Click it, or choose
**Tools → MySpec → MySpec Account…**, to open the account menu. It shows which
credential is in use and offers:

- **Switch organization…** (browser sign-in only)
- **Switch project…**
- **Sign out**
- **Settings…**

## Link a project

The plugin needs to know which MySpec project belongs to the IDE project you
have open.

1. Select **Link a project** in the tool window, or choose
   **Tools → MySpec → Link a MySpec Project…**.
2. Pick a project from the list.

The **Spec Files**, **Attachments**, **Tasks** and **Discussions** tabs fill
in. The IDE remembers the link for this IDE project, so the MySpec project is
there when you reopen it. Use **Switch MySpec Project…** to link another one,
or **Unlink MySpec Project** to remove the link.

## Use it

Double-click (or press Enter on) an item to open it; right-click for everything
else. Account and project actions are under **Tools → MySpec**, and every
action is in **Find Action** (type "MySpec").

- **Spec Files**: open a file to read it (Markdown preview works). Expand it to
  see its revisions; right-click a revision to **Compare with Current** or
  **Compare with Previous Revision**.
- **Comments**: select text in a spec file, right-click and choose
  **Add MySpec Comment…**. Threads show as gutter icons and in the
  **Discussions** tab.
- **Tasks**: the tab shows tasks assigned to you; use the filters to see all,
  unassigned or one member's. Right-click a task for **Set Status…** and
  **Edit Planning…**, then **Submit Task Changes** in the tab's toolbar to send
  them. Unsent changes show as `● unsubmitted` and stay in this IDE project for
  up to 14 days.
- **Copy Prompt for AI Agent**: right-click tasks or a tasks file. Add `.specs/`
  to `.gitignore` if you do not want to commit the saved spec files.
- **Download…** and **Open in MySpec** are on the right-click menus.

Tabs refresh when you come back to the IDE. Use **Refresh** in the toolbar for
an immediate reload. MySpec files are not reopened after an IDE restart; open
them again from the tool window.

## Sign out

Choose **Tools → MySpec → Sign Out of MySpec**, or use the account menu.

- **Browser sign-in**: this also signs out the MySpec MCP server and VS Code on
  this machine. The IDE asks you to confirm.
- **API token saved in the IDE**: the token is removed from the IDE. To stop it
  working everywhere, [revoke it](https://docs.myspec.dev/mcp/api-tokens/#revoke-a-token) in MySpec.
- **API token in `~/.myspec/oauth_creds.json`**: signing out keeps it. Delete
  its `apiToken` field to remove it.
- **`MYSPEC_API_TOKEN`**: unset the variable and restart the IDE.

## Settings

**Settings → Tools → MySpec**. These settings apply to every IDE project.

| Setting | Default | What it does |
|---|---|---|
| Environment | **Follow the MySpec MCP sign-in** | Uses the same MySpec environment as the MCP server's sign-in on this machine, otherwise MySpec itself. You normally leave it as is. |
| Show resolved threads in the editor | Off | The **Discussions** tab always lists them. |

The plugin logs to the IDE log (**Help → Show Log**). Tokens are never written
to it.

## Troubleshooting

| Problem | What to do |
|---|---|
| The sign-in dialog keeps waiting after you signed in in the browser | Paste the value the sign-in page shows into the dialog's token field. See [Sign in on a remote machine](#sign-in-on-a-remote-machine-or-another-device). |
| The pasted token is refused | Copy the whole `<code>.<state>` value, including the dot, not the `code=` part of the address. If more than a minute passed, sign in again. |
| "You do not belong to any organization yet" | Create a workspace in [MySpec](https://app.myspec.dev), then sign in again. |
| "No organization was chosen" | Choose **Tools → MySpec → Switch MySpec Organization…** and pick one. |
| "The project linked to this IDE project belongs to another organization" | Select **Switch organization**, or **Pick another project**. |
| "The project linked to this IDE project is not available" | It was deleted, or you lost access. Select **Pick another project**. |
| "Could not reach MySpec" | Check your connection, then select **Try again**. |
| The API token is rejected | It expired, was revoked, or you left its organization. [Create a new token](https://docs.myspec.dev/mcp/api-tokens/#create-a-token). |
| You cannot comment or change tasks | You are using a **Read only** token. Sign in with your browser, or use a **Read and write** token. |
| "Tasks aren't available for this organization" | The task board is not turned on for your organization. |
| "Refusing to load credentials … file mode is too permissive" | Run `chmod 600 ~/.myspec/oauth_creds.json`, then choose **Tools → MySpec → Refresh MySpec**. |
| You appear signed out, with a note that the MCP server is signed in elsewhere | The MCP server on this machine is signed in to a different MySpec environment. Sign in again here, or set **Environment** back to **Follow the MySpec MCP sign-in**. |

For anything else, check the IDE log and see [Help](https://docs.myspec.dev/help/).

Source: https://docs.myspec.dev/ide/jetbrains/index.mdx
