yFiles CLI for Avalonia

The yFiles CLI for Avalonia is the command-line entry point for yFiles for Avalonia developer tools.

Features:

• MCP server that connects MCP-compatible AI assistants to the yFiles for Avalonia documentation and development tools. It runs locally and communicates with your assistant over standard input and output.

Run the CLI without a command to see the available commands and options:

npx --yes yfiles-cli-avalonia --help

Commands

• login — sign in to yWorks and store credentials locally
• logout — sign out and clear stored credentials
• mcp — start the local MCP server

Requirements

• Node.js 22 or newer
• An MCP-compatible AI assistant
• A yWorks account with an active yFiles for Avalonia (evaluation) license.

Sign in

Sign in once before adding the server to your AI assistant:

npx --yes yfiles-cli-avalonia login

Your browser opens the yWorks login page. Complete the sign-in there, then return to the terminal. The sign-in is remembered for later sessions.

To sign out or switch accounts:

npx --yes yfiles-cli-avalonia logout

Configure your AI assistant

Add the following server entry to the configuration of your MCP-compatible assistant:

{
  "mcpServers": {
    "yfiles-avalonia": {
      "command": "npx",
      "args": ["--yes", "yfiles-cli-avalonia", "mcp"]
    }
  }
}

If you are running your AI agent on Windows and encounter execution errors, you may need to explicitly specify the command shell extension. Change the "command" value from "npx" to "npx.cmd".

The exact location of this configuration depends on the assistant you use. Restart the assistant after saving the configuration. Once connected, the yFiles Avalonia tools should be available in a new conversation.

Troubleshooting

If the assistant cannot connect:

1. Check that Node.js 22 or newer is installed by running node --version.
2. Run the sign-in command again and make sure the browser login completes successfully.
3. Restart the assistant after changing its MCP configuration.
4. If another application is using the local login callback port, close that application and try signing in again.

About yFiles

yFiles is the leading commercial software library for visualizing, editing, and analyzing graphs.

Contact

yfiles.com/contact

yWorks GmbH
Vor dem Kreuzberg 28
72070 Tübingen
Germany

Privacy Policy

yWorks privacy policy

yFiles MCP privacy policy