ymcp is a local MCP server for YouTrack, including self-hosted instances behind a VPN. It speaks for you with your login and password, ships every tool of YouTrack’s built-in MCP server under the same names, and adds the ones it lacks: deleting things, sprints, attachments, history, time reports, commands and more.
- 58 tools: the 23 built-in ones, same names, arguments and limits, plus 35 extras
- Signs in like the web UI, so there is no admin-issued token or OAuth client; the password lives in your system keychain
- Works without admin rights: field schemas, groups and comments fall back to what a regular user can read
- One-command install that registers itself in Claude, Cursor, VS Code, Zed, Codex, Gemini and 8 more clients
- Single static binary for macOS, Linux and Windows, with
ymcp updatebuilt in
macOS / Linux:
curl -fsSL https://raw.githubusercontent.com/xlsft/ymcp/main/install.sh | shWindows (PowerShell):
irm https://raw.githubusercontent.com/xlsft/ymcp/main/install.ps1 | iexOr with a package manager, then run ymcp setup:
brew install xlsft/tap/ymcp # macOS, Linux
scoop bucket add xlsft https://github.com/xlsft/scoop-bucket; scoop install ymcp # Windows
winget install xlsft.ymcp # Windows, once Microsoft accepts itPackage-managed copies update through their manager (brew upgrade ymcp and so on); ymcp update says so.
The installer downloads the latest release and checks its SHA-256. It then runs ymcp setup, which:
- asks for a profile name,
youtrackby default; - asks for your YouTrack URL, login and password, and verifies them before saving anything;
- lists the MCP clients found on your machine, with a checkbox for each;
- registers ymcp as a stdio server in the clients you pick, and removes it from the ones you uncheck.
Run ymcp setup again at any time to edit a profile, add or remove clients, or add another YouTrack.
Each YouTrack instance is a profile, and each profile is its own MCP server. The profile's display name gives the
server name: YouTrack (xlsft) becomes youtrack-xlsft, youtrack-beget stays as it is. A repeated ymcp setup
lists your profiles: pick one to edit it, rename it (its client entries move along), or add or remove a profile.
Clients run ymcp --profile <key>, so every instance shows up next to the others with its own tools.
Releases are signed keylessly with Sigstore by this repository's release workflow:
checksums.txt has a checksums.txt.sigstore.json bundle, and each archive an SPDX SBOM (*.sbom.json).
cosign verify-blob checksums.txt --bundle checksums.txt.sigstore.json \
--certificate-identity-regexp '^https://github.com/xlsft/ymcp/\.github/workflows/' \
--certificate-oidc-issuer https://token.actions.githubusercontent.com
sha256sum --ignore-missing -c checksums.txtThe Docker image is signed the same way and carries SBOM and provenance attestations:
cosign verify xlsoftware/ymcp:latest \
--certificate-identity-regexp '^https://github.com/xlsft/ymcp/\.github/workflows/' \
--certificate-oidc-issuer https://token.actions.githubusercontent.com| Command | |
|---|---|
ymcp / ymcp serve |
Run the MCP server over stdio (what clients launch). --transport http serves Streamable HTTP, see HTTP |
ymcp setup |
Add or edit a profile, sign in, pick its tools and MCP clients. --name, --tools, --clients cursor,zed, --all, --reauth and --remove skip the questions |
ymcp auth |
Set or replace the URL, login and password of a profile. --url, --login, --proxy, --password-stdin for scripts |
ymcp check |
Sign in and print who you are |
ymcp call <tool> '<json>' |
Call one tool, exactly as a client would, e.g. ymcp call count_issues '{"query":"#Unresolved"}' |
ymcp health |
Check that a running HTTP server answers (--url, default http://127.0.0.1:8090) |
ymcp logs |
Show what the server did; -f follows the log live, -n 200 shows more lines |
ymcp update |
Replace the binary with the latest release (--check only reports) |
ymcp version |
Print the version |
| Area | Tools |
|---|---|
| Issues | search_issues, get_issue, create_issue, create_draft_issue, update_issue, change_issue_assignee, get_issue_fields_schema |
| Comments, tags, links, time | add_issue_comment, get_issue_comments, manage_issue_tags, link_issues, log_work, get_saved_issue_searches |
| Knowledge base | search_articles, get_article, create_article, update_article |
| Projects and people | find_projects, get_project, find_user, get_current_user, find_user_groups, get_user_group_members |
Custom fields are set by their display name, e.g. {"State": "In Progress", "Fix versions": ["2.1"]}. ymcp looks up
the field type and checks the value against the project before sending it. That includes the allowed assignees, so a
wrong value comes back with the list of valid ones.
| Area | Tools |
|---|---|
| Delete and undo | delete_issue, delete_issue_comment, restore_issue_comment, delete_article, delete_work_item, unlink_issues |
| Agile boards and sprints | find_agile_boards, get_agile_board, get_sprint, create_sprint, update_sprint, add_issue_to_sprint, remove_issue_from_sprint, delete_sprint |
| History and reports | get_issue_activities, count_issues, get_time_report, get_issue_work_items |
| Bulk changes | apply_command: any command from the YouTrack command dialog, on issues or a query (up to 100), validated first, with dryRun |
| Attachments | Of issues and knowledge base articles: get_issue_attachments, get_attachment (text inline, images as images, other files saved locally), add_attachment (several files at once), delete_attachment |
| Comments | update_issue_comment |
| Partial text edits | edit_issue_description, edit_article_content: find-and-replace in a description or article, exact or by regular expression with capture groups, so a small change doesn't resend the whole text |
| VCS | get_issue_vcs_changes: commits and pull requests from GitHub, GitLab, Bitbucket, Gitea or TeamCity integrations |
| Tags and saved searches | find_tags, create_tag, update_tag, delete_tag, create_saved_search, update_saved_search, delete_saved_search |
| Escape hatch | call_api: any YouTrack or Hub REST endpoint as you, for whatever the other tools don't cover |
Every command takes --profile <key> (or YMCP_PROFILE) to pick the YouTrack instance, e.g.
ymcp --profile youtrack-beget check. Without it ymcp uses the youtrack profile, or the only one there is.
Tools that delete or bulk-change data are marked with destructiveHint, so clients ask before running them.
Errors tell the model what to do next. ymcp's own checks list what is allowed (value "X" is not allowed; allowed: Critical, Major, …), and errors from YouTrack get a hint by status: which tool finds the right ID after a 404,
that a 403 needs a permission rather than a retry, that a 401 needs ymcp auth. HTML error pages from proxies are
cut down to their title.
Clients that support MCP prompts list these as slash commands. Each one tells the model which tools to use and in what order, and they never change YouTrack without asking:
| Prompt | |
|---|---|
standup |
What I did since the last working day (Friday on a Monday), what's next, what blocks me. days looks further back |
triage |
Untriaged issues of a project with proposed type, priority, assignee and duplicates; applies only what you approve |
sprint_report |
A sprint of a board: done and open work, who has what, scope changes, time logged, risks |
issue_brief |
Catch up on an issue: TL;DR, state, decisions, open questions, next steps |
A prompt is offered only when the tools it needs are served (see below).
All 58 tools take room in the model's context. A profile can serve only some groups of them: pick them in
ymcp setup, or pass --tools (or YMCP_TOOLS) to serve, which wins over the profile.
| Group | Tools |
|---|---|
issues |
search, count, read, create, edit, drafts, delete, commands, links, history, VCS changes |
comments |
read, add, edit, delete, restore |
attachments |
files on issues and articles |
articles |
knowledge base |
time |
work items and time reports |
agile |
boards and sprints |
projects |
find and describe projects |
people |
users and groups |
tags |
tags and tagging issues |
searches |
saved searches |
api |
call_api |
A selection mixes groups and tool names, and - removes one: issues,comments,articles,-delete_issue. Removals
alone start from everything, e.g. -api,-agile. The start-up log shows what is served, e.g.
tools="19 of 58: issues, comments, -delete_issue".
ymcp setup and ymcp auth store each profile's name, URL, login and proxy in <config dir>/ymcp/config.json,
a file only you can read:
- macOS:
~/Library/Application Support - Linux:
~/.config - Windows:
%APPDATA%
The password goes to the system keychain: Keychain on macOS, Secret Service on Linux, Credential Manager on Windows. It falls back to the config file only where no keychain exists.
Environment variables override the stored values of the profile in use. That's handy for CI:
| Variable | |
|---|---|
YOUTRACK_URL |
Instance root, e.g. https://youtrack.example.com (no /api) |
YOUTRACK_LOGIN, YOUTRACK_PASSWORD |
YouTrack or Hub account, LDAP included |
YOUTRACK_PROXY |
Empty to use HTTP(S)_PROXY (or direct, when that proxy can't reach YouTrack), none to always connect directly, or a proxy URL |
YMCP_PROFILE |
Profile to use, like --profile |
YMCP_TOOLS |
Tools to serve, like serve --tools |
YMCP_CONFIG |
Path of the config file |
--env FILE loads these variables from a dotenv file (see .env.example).
Behind a VPN? MCP clients often pass an
HTTP(S)_PROXYmeant for the internet. Such a proxy resolves an internal YouTrack through public DNS and never reaches it. When the proxy comes from the environment and doesn't lead to YouTrack, ymcp connects directly instead and logs why. An explicitly configured proxy is always used.
ymcp serve --transport http serves every profile from one process, each at its own path, over Streamable HTTP:
YMCP_HTTP_TOKEN=$(openssl rand -hex 32) ymcp serve --transport http --addr 127.0.0.1:8090The start-up log lists each profile with its URL, e.g. http://127.0.0.1:8090/youtrack-beget. The default profile
is also served at /. --profiles a,b serves only those, and --profile a serves just one. A profile that can't sign
in is skipped with a warning.
GET /healthz answers {"status":"ok","version":"…"} without the token, for load balancers and monitoring, and
ymcp health checks it from the command line. The Docker image uses it as its HEALTHCHECK.
With --token or YMCP_HTTP_TOKEN, every request must carry Authorization: Bearer <token>; set that header in
the client's entry for the URL. Without a token the server is open to anyone who can reach it, so keep it on
127.0.0.1 (the default) or set a token; ymcp warns when it listens elsewhere without one.
The xlsoftware/ymcp image runs the HTTP server for linux/amd64 and linux/arm64.
Profiles live in the /config volume. There is no keychain in a container, so passwords are kept in that volume's
config file (mode 0600); treat the volume as a secret.
Add a profile. auth asks for the URL, login and password and checks them before saving:
docker run -it --rm -v ymcp:/config xlsoftware/ymcp auth
docker run -it --rm -v ymcp:/config xlsoftware/ymcp --profile youtrack-beget auth # another instanceRun the server on port 8090 with a token:
docker run -d --name ymcp --restart unless-stopped \
-p 127.0.0.1:8090:8090 -v ymcp:/config \
-e YMCP_HTTP_TOKEN="$(openssl rand -hex 32)" \
xlsoftware/ymcp
docker logs ymcp # lists each profile and its URLFor a single instance without a volume, pass the connection instead:
-e YOUTRACK_URL=https://youtrack.example.com -e YOUTRACK_LOGIN=… -e YOUTRACK_PASSWORD=….
Then point clients at a profile's URL with the token, e.g. in Claude Code:
claude mcp add --transport http youtrack http://127.0.0.1:8090/youtrack --header "Authorization: Bearer <token>"or in a JSON config:
{ "mcpServers": { "youtrack": { "type": "http", "url": "http://127.0.0.1:8090/youtrack",
"headers": { "Authorization": "Bearer <token>" } } } }A busy or restarting YouTrack doesn't fail a tool call right away. ymcp retries up to three times, waiting 0.5,
1 and 2 seconds or as long as Retry-After asks (up to 10 s): on 429 and 503 for any request, and on 502, 504 and
dropped connections only for requests that are safe to repeat. A POST that may already have created an issue or
comment is never sent twice. Each retry is logged.
The server logs its start, every client that connects and every tool call. At start it also checks GitHub in the
background and, when a newer release is out, logs update available current=0.4.0 latest=0.5.0 run="ymcp update". Each line has the arguments, how long the
call took and any error. Sign-ins are logged too. The log goes to stderr, which clients like Claude Desktop keep in
their own MCP logs. It is also appended to a file, so you can watch it while a client runs ymcp:
ymcp logs -fThe file is ~/Library/Logs/ymcp/ymcp.log on macOS, ~/.local/state/ymcp/ymcp.log on Linux and
%LOCALAPPDATA%\ymcp\logs\ymcp.log on Windows. It rotates at 5 MB.
| Setting | |
|---|---|
ymcp -v serve or YMCP_LOG_LEVEL=debug |
Also log every YouTrack and Hub request with status and timing |
YMCP_LOG_LEVEL |
debug, info (default), warn or error |
YMCP_LOG_FILE |
Another path for the file, or off |
YMCP_UPDATE_CHECK=off |
Don't look for a newer release at start |
To log at debug level from a client, add "env": {"YMCP_LOG_LEVEL": "debug"} to its ymcp entry.
Claude Code · Claude Desktop · Cursor · VS Code (Copilot) · Windsurf · Devin Desktop · Zed · Codex · Gemini CLI · Antigravity · JetBrains Junie · Cline · LM Studio · opencode · Kimi Code
Claude Desktop writes its config back from memory while it runs, which drops edits made meanwhile, so ymcp setup
offers to quit it during the change and reopens it afterwards.
ymcp edits each client's config in place and keeps your other servers, keys and comments. It leaves a
.ymcp.bak copy next to the original. For any other client, register a stdio server per profile that runs the
ymcp binary with --profile <key>:
{ "mcpServers": { "youtrack": { "command": "/path/to/ymcp", "args": ["--profile", "youtrack"] } } }YouTrack’s OAuth password grant needs a service secret, and regular users don't have one. So ymcp signs in the same way the YouTrack web app does:
- Read the Hub location and YouTrack service ID from the public
/api/config. - Submit the Hub login form and keep the session cookie.
- Run the implicit OAuth flow of the YouTrack web client and take the bearer token from the redirect.
Expired tokens are renewed from the session without resending the password. The password is sent again only when the session itself has expired. A separate Hub-scoped token is fetched lazily for the Hub API, which group members need. Two-factor authentication is not supported yet.
go build -o bin/ymcp ./cmd/ymcp
go test -race ./...
./bin/ymcp --env .env call get_current_userUnit tests never touch the network. internal/youtrack/youtracktest emulates
YouTrack and Hub, including the login form, the OAuth redirects and token revocation. The tool tests call tools through
an in-memory MCP client and check the REST requests they send.
E2E tests (e2e/) start the built binary over stdio against a real YouTrack. They call all 58 tools on a
throwaway project and delete everything they create. They run in CI on every push and nightly.
See CONTRIBUTING.md for the commit and release flow.
MIT. Not affiliated with JetBrains; YouTrack is a trademark of JetBrains s.r.o.