@likec4/mcp

Documentation

Usage

{
  "mcpServers": {
    "likec4": {
      "command": "npx",
      "args": [
        "-y",
        "@likec4/mcp"
      ],
      "env": {
        "LIKEC4_WORKSPACE": "${workspaceFolder}"
      }
    }
  }
}

This package starts MCP server using stdio transport.

If LIKEC4_WORKSPACE environment variable is not set, the current directory will be used as workspace.

Usage as CLI

Install it globally (or use npx):

npm install -g @likec4/mcp
likec4-mcp-server -h

USAGE `likec4-mcp-server [OPTIONS] [WORKSPACE]`

ARGUMENTS

  `WORKSPACE="."`    change workspace, defaults to current directory, can be set by LIKEC4_WORKSPACE env    <directory>

OPTIONS

          `--stdio`    use stdio transport (this is default)
           `--http`    use streamable http transport
  `--port=<number>`    change http port (default: 33335)
       `--no-watch`    disable watch for changes (consume less resources if you have static workspace)

Available tools

• list-projects: List all LikeC4 projects in the workspace.
• read-project-summary: Project specification (element kinds, deployment node kinds, tags, metadata keys), all elements, deployment nodes and views.
• search-element: Search elements and deployment nodes across all projects by id/title/kind/shape/tags/metadata.
• read-element: Full element details including relationships, includedInViews, deployedInstances, metadata and sourceLocation.
• read-deployment: Details of a deployment node or deployed instance.
• read-view: Full view details (nodes/edges) and sourceLocation.
• find-relationships: Direct and indirect relationships between two elements in a project.
• open-view: Opens the LikeC4 view (available if MCP is running in the editor)

Getting help

We are always happy to help you get started:

• Join Discord community – it is the easiest way to get help
• GitHub Discussions – ask anything about the project or give feedback

Contributors

Become a contributor

Support development

LikeC4 is a MIT-licensed open source project with its ongoing development made possible entirely by your support.
If you like the project, please consider contributing financially to help grow and improve it.
You can support us via OpenCollective or GitHub Sponsors.

License

This project is released under the MIT License