Skip to content

golutra/golutra-mcp

BranchesTags

Repository files navigation

golutra logo

golutra-mcp

MCP bridge for Golutra via golutra-cli.
通过 golutra-cli 暴露 Golutra 能力的 MCP 桥接层。

npm version npm downloads ci node version license

English · 中文 · npm · GitHub · Startup Process · Workspace Examples · Diagnose Examples

Keep Golutra as the app runtime. Use golutra-cli as the stable boundary. Expose the workflow through MCP.
保留 Golutra 作为桌面运行时，以 golutra-cli 作为稳定边界，再通过 MCP 暴露给外部 AI 宿主。

English

Install

golutra-mcp is now published on npm as golutra-mcp.

Install it as a normal MCP server package:

npm install -g golutra-mcp

Run it with a published Golutra desktop installation.

macOS:

export GOLUTRA_CLI_PATH=/Applications/Golutra.app/Contents/MacOS/golutra-cli
export GOLUTRA_PROFILE=stable
export GOLUTRA_WORKSPACE_PATH=/absolute/path/to/workspace
golutra-mcp

Windows PowerShell:

$env:GOLUTRA_CLI_PATH="C:\Users\<you>\AppData\Local\Programs\Golutra\golutra-cli.exe"
$env:GOLUTRA_PROFILE="stable"
$env:GOLUTRA_WORKSPACE_PATH="C:\absolute\path\to\workspace"
golutra-mcp

Linux:

export GOLUTRA_CLI_PATH=/usr/bin/golutra-cli
export GOLUTRA_PROFILE=stable
export GOLUTRA_WORKSPACE_PATH=/absolute/path/to/workspace
golutra-mcp

What This Project Is

golutra-mcp is a Model Context Protocol server that exposes Golutra collaboration capabilities to MCP-compatible hosts through golutra-cli.

It is not a replacement for Golutra itself, and it does not re-implement Golutra's local IPC protocol. Instead, it acts as a thin integration layer that lets external MCP clients reuse Golutra's existing team-building, chat, roadmap, prompt, automation, and skill flows through a smaller and more stable boundary.

What It Is Today

The current project is an installable public MCP server release with its first npm distribution already published.

Today it already provides:

  • a local stdio MCP server
  • a command bridge based on golutra-cli
  • tool coverage for CLI guides, team config, terminal creation, member rename/delete, conversation topology, chat, roadmap, prompt settings, member bindings, automation, agents, templates, template export/use, store commands, context, diagnostics, and skill discovery
  • skill validation and direct project SKILL.md reading for local Golutra skill workflows
  • an open-source project skeleton with contribution, security, CI, and release-facing metadata

At the current stage, it should be understood as a real downloadable integration package that is ready for evaluation, pilot usage, and downstream MCP wiring, but still needs broader real-world validation before it should be treated as a fully hardened long-term public integration product.

Why It Exists

The goal is to let MCP hosts talk to Golutra without forcing them to understand Golutra internals.

That means this repository is mainly responsible for:

  • protocol translation
  • runtime context management
  • safe command wrapping
  • diagnostics and integration ergonomics

Runtime Requirements

To work correctly, the server still depends on the existing Golutra desktop runtime:

  • a locally installed Golutra desktop application
  • a reachable golutra-cli binary
  • a valid Golutra workspace path
  • the target Golutra app runtime running locally. By default MCP tries stable desktop, stable server/web, dev desktop, then dev server/web.

Default CLI discovery by platform:

  • macOS: /Applications/Golutra.app/Contents/MacOS/golutra-cli, then ~/Applications/Golutra.app/Contents/MacOS/golutra-cli, then golutra-cli from PATH
  • Windows: %LOCALAPPDATA%\Programs\Golutra\golutra-cli.exe, then %ProgramFiles%\Golutra\golutra-cli.exe, then %ProgramFiles(x86)%\Golutra\golutra-cli.exe, then golutra-cli.exe from PATH
  • Linux: ~/.local/bin/golutra-cli, then ~/.cargo/bin/golutra-cli, then /usr/local/bin/golutra-cli, /usr/bin/golutra-cli, /opt/Golutra/golutra-cli, /app/bin/golutra-cli, then golutra-cli from PATH

Diagnostics

Use golutra-diagnose when you need to separate:

  • CLI path problems
  • missing or invalid workspace paths
  • workspace team config and app-backed command failures
  • app-not-running or profile-mismatch failures
  • generic app command failures

Detailed diagnostic output fields and common reasonCode values are documented in docs/GOLUTRA_DIAGNOSE_EXAMPLES.md.

What An AI Host Should Do

If an AI system or MCP-compatible host sees this repository, the intended usage is:

  1. Launch golutra-mcp as a local stdio MCP server, not as an HTTP service.
  2. Provide GOLUTRA_CLI_PATH and usually GOLUTRA_WORKSPACE_PATH. Leave profile/host unset to use the default target order, or set GOLUTRA_PROFILE, GOLUTRA_CLI_HOST_KIND, or GOLUTRA_TARGET_ORDER when you need a specific runtime.
  3. Call golutra-get-context or golutra-diagnose first to confirm runtime readiness.
  4. Read the relevant guide before acting, for example golutra-read-cli-guide with guide: "team" before team creation.
  5. Use the structured team-building flow instead of inventing a custom transport: golutra-read-team-config -> golutra-list-terminal-defaults / golutra-create-terminals / conversation tools / prompt tools / automation tools.
  6. For runtime collaboration after the team exists, use: golutra-list-conversations -> golutra-list-messages / golutra-send-message / golutra-read-roadmap / golutra-update-roadmap.
  7. Treat golutra-cli as the stable boundary. Do not bypass this project by directly calling Golutra local socket IPC unless you intentionally want to maintain a separate integration layer.
  8. For destructive or restart tools, pass the explicit confirmation fields required by the tool schema, such as confirmedMemberId or confirmedConversationId.
  9. When switching workspaces for a single request, pass workspacePath on that tool call. Use golutra-set-context only when you want to persist a new default for later calls.

In short: start with diagnostics, read golutra-read-team-config for the workspace shape, keep workspace/profile/host explicit when needed, and use the provided MCP tools as the integration contract.

For concrete workspace switching and chat flow examples, see docs/WORKSPACE_CONTEXT_EXAMPLES.md.

Future Direction

The next stages should move the project from "basic bridge" to "usable integration product."

Likely future work includes:

  • richer typed result models instead of mostly pass-through payloads
  • stronger health checks and diagnostics for CLI, profile, workspace, and app status
  • clearer MCP resource/prompt support in addition to tool calls
  • better packaging and publish flow once dependency install and build are stable in target environments
  • tighter documentation around real Golutra collaboration workflows
  • stronger release hardening across installation paths, packaging validation, and end-to-end compatibility checks

Source Development

If you want to run or modify the repository from source instead of installing the npm package:

npm install
export GOLUTRA_CLI_PATH=/absolute/path/to/golutra-cli
export GOLUTRA_PROFILE=stable
export GOLUTRA_WORKSPACE_PATH=/absolute/path/to/workspace
npm run dev

Detailed startup, validation, and client wiring instructions live in STARTUP_PROCESS.md.

中文

安装方式

golutra-mcp 现在已经以 golutra-mcp 这个包名发布到 npm。

按普通 MCP Server 包安装即可：

npm install -g golutra-mcp

建议配合已安装的 Golutra 桌面应用直接运行。

macOS：

export GOLUTRA_CLI_PATH=/Applications/Golutra.app/Contents/MacOS/golutra-cli
export GOLUTRA_PROFILE=stable
export GOLUTRA_WORKSPACE_PATH=/absolute/path/to/workspace
golutra-mcp

Windows PowerShell：

$env:GOLUTRA_CLI_PATH="C:\Users\<you>\AppData\Local\Programs\Golutra\golutra-cli.exe"
$env:GOLUTRA_PROFILE="stable"
$env:GOLUTRA_WORKSPACE_PATH="C:\absolute\path\to\workspace"
golutra-mcp

Linux：

export GOLUTRA_CLI_PATH=/usr/bin/golutra-cli
export GOLUTRA_PROFILE=stable
export GOLUTRA_WORKSPACE_PATH=/absolute/path/to/workspace
golutra-mcp

这是什么项目

golutra-mcp 是一个把 Golutra 能力暴露给 MCP 客户端的桥接层，底层通过 golutra-cli 与 Golutra 桌面端联通。

它不是 Golutra 本体，也不是对 Golutra 本地 IPC 协议的重写。这个仓库的职责，是把外部 MCP Host 和 Golutra 之间的集成边界收敛成一层更小、更稳定、更容易复用的适配层，覆盖团队创建、聊天、路线图、提示词、自动化和技能等主要工作流。

当前阶段是什么

当前这个项目已经进入“可下载安装的公开版本”阶段，并且第一版 npm 包已经发布。

现阶段已经具备：

  • 基于 stdio 的 MCP Server 形态
  • 基于 golutra-cli 的命令桥接
  • CLI 指南、team config、terminal 创建、成员删除、频道/私聊拓扑、chat、roadmap、prompt settings、member bindings、automation、agents、templates、store commands、context、diagnostics、skills 等工具面
  • 技能校验与项目 SKILL.md 直接读取能力，能覆盖本地技能开发链路
  • 基本完整的开源项目骨架，包括贡献规范、安全策略、CI 和发布元数据

但它现在还不是一个“已经经过大规模真实场景验证、长期充分打磨”的成熟公共集成产品。更准确的定位是：一个已经可以下载安装、接入验证、试点使用的 Golutra MCP 集成层。

这个项目解决什么问题

这个项目的目标，是让支持 MCP 的宿主可以接入 Golutra，而不需要理解 Golutra 内部的本地 IPC 细节。

因此，这个仓库重点负责的是：

  • 协议转换
  • 运行时上下文管理
  • 对现有 CLI 能力的稳定封装
  • 联通诊断与集成体验

运行前提

这个 MCP Server 运行时依赖现有的 Golutra 本地运行环境：

  • 本机已安装 Golutra 桌面应用
  • 能访问到 golutra-cli
  • 已知的有效工作区路径
  • 本地已启动目标 Golutra 运行实例。默认查找顺序是 stable 桌面端、stable server/web、dev 桌面端、dev server/web。

按平台的默认 CLI 自动发现顺序：

  • macOS：/Applications/Golutra.app/Contents/MacOS/golutra-cli，然后 ~/Applications/Golutra.app/Contents/MacOS/golutra-cli，最后回退到 PATH 里的 golutra-cli
  • Windows：%LOCALAPPDATA%\Programs\Golutra\golutra-cli.exe，然后 %ProgramFiles%\Golutra\golutra-cli.exe，再然后 %ProgramFiles(x86)%\Golutra\golutra-cli.exe，最后回退到 PATH 里的 golutra-cli.exe
  • Linux：~/.local/bin/golutra-cli，然后 ~/.cargo/bin/golutra-cli、/usr/local/bin/golutra-cli、/usr/bin/golutra-cli、/opt/Golutra/golutra-cli、/app/bin/golutra-cli，最后回退到 PATH 里的 golutra-cli

诊断能力

需要排查问题时，可以优先用 golutra-diagnose 区分：

  • CLI 路径问题
  • workspacePath 缺失或非法
  • 工作区团队配置读取与 app 侧命令失败
  • 桌面应用未运行或 profile 不匹配
  • 普通 app 命令失败

更完整的诊断输出字段和常见 reasonCode 说明见 docs/GOLUTRA_DIAGNOSE_EXAMPLES.md。

AI 看到这个项目后应该怎么做

如果一个 AI 系统或支持 MCP 的宿主看到这个仓库，推荐按下面方式接入：

  1. 把 golutra-mcp 当作本地 stdio MCP Server 启动，不要把它当成 HTTP 服务。
  2. 提供 GOLUTRA_CLI_PATH，通常还需要提供 GOLUTRA_WORKSPACE_PATH。profile/host 不填时使用默认查找顺序；需要固定运行实例时再设置 GOLUTRA_PROFILE、GOLUTRA_CLI_HOST_KIND 或 GOLUTRA_TARGET_ORDER。
  3. 先调用 golutra-get-context 或 golutra-diagnose，确认运行时上下文和联通状态。
  4. 执行前先读对应指南，例如创建团队前用 golutra-read-cli-guide 读取 guide: "team"。
  5. 创建团队时按标准工具链路走，不要自造传输协议： golutra-read-team-config -> golutra-list-terminal-defaults / golutra-create-terminals / 会话拓扑工具 / 提示词工具 / 自动化工具。
  6. 团队创建完成后的运行期协作使用： golutra-list-conversations -> golutra-list-messages / golutra-send-message / golutra-read-roadmap / golutra-update-roadmap。
  7. 把 golutra-cli 视为稳定边界。除非你明确准备长期维护另一套集成层，否则不要绕过这个项目去直连 Golutra 本地 socket IPC。
  8. 删除或重启类工具必须按 tool schema 传入显式确认字段，例如 confirmedMemberId 或 confirmedConversationId。
  9. 如果只是某一次调用切换工作区，就在该次 tool 调用里显式传 workspacePath。只有在你希望后续调用默认都改到新工作区时，才使用 golutra-set-context。

一句话概括：先诊断，再用 golutra-read-team-config 读取工作区形态，必要时显式指定 workspace/profile/host，然后把 README 里提供的 MCP tools 当作正式集成契约来用。

如果你想看“工作区切换”和“真实聊天链路”的具体调用示例，直接看 docs/WORKSPACE_CONTEXT_EXAMPLES.md。

后续规划

后续项目应该从“能桥接”继续推进到“更好用、可发布、可维护”。

比较明确的方向包括：

  • 把当前偏透传的结果结构进一步做强类型化
  • 增强 CLI / profile / workspace / app 状态诊断
  • 在 tool 之外补充更完整的 MCP resources / prompts 能力
  • 把打包、安装、发布链路收敛到更稳定的状态
  • 补齐围绕真实 Golutra 协作场景的文档和示例
  • 继续补强跨平台安装路径、自诊断、端到端兼容性验证

源码开发

如果你要按源码方式运行或参与开发：

npm install
export GOLUTRA_CLI_PATH=/absolute/path/to/golutra-cli
export GOLUTRA_PROFILE=stable
export GOLUTRA_WORKSPACE_PATH=/absolute/path/to/workspace
npm run dev

更完整的启动、验证与客户端接入说明见 STARTUP_PROCESS.md。

Documentation

About

No description, website, or topics provided.

Resources

Readme

License

Apache-2.0 license

Code of conduct

Code of conduct

Contributing

Contributing

Security policy

Security policy
Activity
Custom properties

Stars

14 stars

Watchers

0 watching

Forks

7 forks
Report repository

Releases 4

v0.1.4 Latest
May 7, 2026
+ 3 releases

Packages

 
 
 

Contributors

Languages