Mcpsync CLI

mcpsync客户端

](https://www.npmjs.com/package/mcpsync-cli) 

所有编码代理的统一MCP服务器配置。

停止在Claude Code、Gemini CLI、OpenAI Codex和其他AI编码工具之间复制MCP服务器配置。定义服务器一次，到处同步。

# Add a server once
mcp-sync add github --command npx --args "-y @modelcontextprotocol/server-github"

# Push to all your coding agents
mcp-sync push

# ✓ claude-code  (3 servers)
# ✓ codex        (3 servers)
# ✓ gemini-cli   (3 servers)
# ✓ roo-code     (3 servers)

安装

npm install -g mcpsync-cli

或者在不安装的情况下使用：

npx mcpsync-cli init

快速开始

# 1. Initialize config
mcp-sync init

# 2. Add your MCP servers
mcp-sync add github
# Interactive prompts guide you through setup

# 3. Sync to all detected agents
mcp-sync push

# 4. Check everything is working
mcp-sync doctor

支持的代理

命令

mcp-sync init

初始化新的配置文件。

mcp-sync init           # Create ~/.config/mcp-sync/config.yaml
mcp-sync init --force   # Overwrite existing config

mcp-sync add

添加新的MCP服务器。

# Interactive mode
mcp-sync add github

# Non-interactive
mcp-sync add github \
  --type stdio \
  --command npx \
  --args "-y" "@modelcontextprotocol/server-github" \
  --env "GITHUB_TOKEN=\${GITHUB_TOKEN}"

# HTTP server
mcp-sync add context7 \
  --type http \
  --url "https://mcp.context7.com/mcp" \
  --env "CONTEXT7_API_KEY=\${CONTEXT7_API_KEY}"

mcp-sync remove

卸下MCP服务器。

mcp-sync remove github

mcp-sync list

列出所有已配置的服务器。

mcp-sync list         # Table format
mcp-sync list --json  # JSON format

mcp-sync push [agent]

将配置同步到代理。

mcp-sync push              # All installed agents
mcp-sync push claude-code  # Specific agent
mcp-sync push --dry-run    # Preview changes

mcp-sync agents

列出检测到的代理及其状态。

mcp-sync agents         # Table format
mcp-sync agents --json  # JSON format

mcp-sync doctor

对您的配置进行健康检查。

mcp-sync doctor

配置

配置存在于 ~/.config/mcp-sync/config.yaml:

version: "1"

defaults:
  timeout: 60
  autoApprove: false

servers:
  # Stdio server (local command)
  github:
    type: stdio
    command: npx
    args:
      - "-y"
      - "@modelcontextprotocol/server-github"
    env:
      GITHUB_PERSONAL_ACCESS_TOKEN: ${GITHUB_TOKEN}
    description: "GitHub API access"
    
    # Agent-specific overrides
    agents:
      codex:
        enabledTools:
          - list_repos
          - get_file_contents
        disabledTools:
          - delete_repo

  # HTTP server (remote)
  context7:
    type: http
    url: https://mcp.context7.com/mcp
    headers:
      CONTEXT7_API_KEY: ${CONTEXT7_API_KEY}
    description: "Documentation lookup"

# Optional: control which agents to sync to
agents:
  claude-code:
    enabled: true
    scope: user
  codex:
    enabled: true

# Optional: exclude servers from specific agents
exclusions:
  - server: github
    agent: roo-code
    reason: "Using different auth method"

环境变量

使用 ${VAR_NAME} 引用环境变量的语法：

env:
  API_KEY: ${MY_API_KEY}           # Required
  API_KEY: ${MY_API_KEY:-default}  # With default value

代理特定设置

某些功能仅由某些代理支持。使用 agents 自定义键：

servers:
  myserver:
    type: stdio
    command: myserver
    agents:
      codex:
        # Codex supports tool filtering
        enabledTools: [tool1, tool2]
        disabledTools: [dangerous_tool]
      claude-code:
        # Different timeout for Claude
        timeout: 120

编程式用法

import { ConfigManager, adapterRegistry } from 'mcpsync-cli';

// Load config
const manager = new ConfigManager();
const config = manager.get();

// Sync to specific adapter
const claudeAdapter = adapterRegistry.get('claude-code');
if (claudeAdapter) {
  await claudeAdapter.write(config);
}

// Detect installed agents
const installed = await adapterRegistry.getInstalled();
for (const adapter of installed) {
  console.log(`Found: ${adapter.displayName}`);
}

发展

# Install dependencies
npm install

# Run unit tests
npm run test:unit

# Run E2E tests in Docker
npm run test:e2e:docker

# Lint code
npm run lint

# Format code
npm run format

# Check formatting
npm run format:check

# Build
npm run build

贡献

欢迎投稿！我们需要帮助的领域：

• 新适配器：基米代码
• 测试：适配器的测试覆盖率
• 文档：特定工作流程指南

添加新适配器

1. 创建 src/adapters/your-agent.ts 实施 BaseAdapter
2. 注册于 src/adapters/index.ts
3. 在中添加测试 tests/adapters/your-agent.test.ts

看 src/adapters/claude-code.ts 以供参考。

许可证

麻省理工学院