Landicefu MCP Client Configuration Server

🚀 MCP 客户端配置服务器

MCP 客户端配置服务器可助力管理不同 MCP 客户端的配置。它提供了一系列工具，用于检索、列出、添加和删除客户端配置文件中的服务器配置。同时，该服务器能够依据操作系统（Windows 或 macOS）以及指定的客户端，自动检测合适的配置文件路径。

🚀 快速开始

本服务器可帮助你便捷地管理 MCP 客户端的配置，通过一系列工具，你能轻松对客户端配置文件中的服务器配置进行操作。

✨ 主要特性

• 依据操作系统（Windows 或 macOS）和指定客户端自动检测配置文件路径。
• 提供检索、列出、添加和删除客户端配置文件中服务器配置的工具。
• 支持多客户端配置管理，确保数据同步、集中管理和版本控制。
• 配置文件修改后以美化 JSON 格式保存。
• 具备错误处理机制，针对找不到配置文件等情况提供相应提示。
• 若配置文件和目录不存在，会自动创建。

📦 安装指南

你可以通过以下两种方式进行安装：

# 从npm安装
npm install -g @landawn/mcp-config-server

# 或者使用yarn
yarn add @landawn/mcp-config-server

📚 详细文档

要将此服务器用作依赖项，请确保它已正确安装。有关配置和使用的详细信息，请参阅项目文档。

📋 支持的客户端

Windows

macOS

📈 使用场景

• 数据同步：在多个客户端之间同步配置，确保一致性。
• 集中管理：在一个地方管理所有客户端的配置，便于维护和更新。
• 版本控制：将配置文件纳入版本控制系统，记录变更历史。

💻 使用示例

基础用法

检索配置

const { getConfig } = require('@landawn/mcp-config-server');

getConfig('cline', 'existing-server').then(config => {
    console.log('Retrieved configuration:', config);
}).catch(err => {
    console.error('Error retrieving configuration:', err);
});

列举所有服务器

const { listConfigs } = require('@landawn/mcp-config-server');

listConfigs('cline').then.servers => {
    console.log('List of servers:', servers);
}).catch(err => {
    console.error('Error listing configurations:', err);
});

高级用法

添加新服务器

const { addConfig } = require('@landawn/mcp-config-server');

addConfig('cline', 'new-server', {
    "api-key": "your-api-key",
    "endpoint": "http://localhost:3000"
}).then(message => {
    console.log('Success message:', message);
}).catch(err => {
    console.error('Error adding configuration:', err);
});

更新现有服务器

const { updateConfig } = require('@landawn/mcp-config-server');

updateConfig('cline', 'existing-server', {
    "allow_override": true,
    "new-setting": "value"
}).then(config => {
    console.log('Updated configuration:', config);
}).catch(err => {
    console.error('Error updating configuration:', err);
});

删除服务器

const { removeConfig } = require('@landawn/mcp-config-server');

removeConfig('cline', 'existing-server').then(message => {
    console.log('Success message:', message);
}).catch(err => {
    console.error('Error removing configuration:', err);
});

🔧 技术细节

• 服务器会依据操作系统和指定客户端自动检测配置文件路径。
• 所有配置文件在修改后都会以美化 JSON 格式保存。
• 具备错误处理机制，针对找不到配置文件等情况提供相应提示。
• 若配置文件和目录不存在，会自动创建。

❓ 常见问题

配置文件未找到

• 添加新服务器时会自动创建配置文件。
• 其他操作在找不到配置文件时会显示错误消息。

服务器已存在

• 更新现有服务器时需要将allow_override设置为true。
• 示例：

{
  "client": "cline",
  "server_name": "existing-server",
  "json_config": { /* 新配置 */ },
  "allow_override": true
}

不受支持的平台

• 目前仅支持 Windows 和 macOS。
• Linux 支持可能在未来的版本中添加。

💡 最佳实践

⚠️ 重要提示

在使用本服务器时，请仔细阅读文档，确保操作正确。

💡 使用建议

• 在更新或删除服务器之前，始终检查其是否存在。
• 使用一致的服务器名称跨客户端进行管理，以简化操作。
• 考虑在服务器配置中使用环境变量来存储敏感信息。