使用说明

项目简介

本项目是羽山数据提供的企业数据服务MCP Server,旨在帮助用户通过LLM快速便捷地访问和使用羽山数据的企业级数据服务。它基于MCP协议构建,可以无缝集成到任何支持MCP协议的LLM客户端或智能体助手,为LLM应用提供强大的数据查询能力。

主要功能点

  • 企业数据查询服务: 连接羽山数据企业级数据服务,提供高效可靠的数据查询能力。
  • MCP协议兼容: 完全兼容Model Context Protocol,确保与各类MCP客户端的无缝对接。
  • 易于配置和部署: 通过简单的配置,即可快速部署和启动MCP Server,无需复杂的开发工作。
  • 支持LLM快速接入: 为LLM应用提供标准化的数据接口,降低LLM应用集成外部数据服务的难度。

安装步骤

  1. 获取Usense UserID和Key: 请联系羽山数据获取您的用户账号与密钥,这是连接羽山数据服务的凭证。
  2. 安装Node.js: 确保您的环境中已安装Node.js和npm。在终端中运行 'node -v' 和 'npm -v' 检查是否安装成功。macOS用户推荐使用brew安装。
  3. 安装依赖: 在项目根目录下,打开终端并运行 'npm install' 命令,安装项目所需的依赖包。
  4. TypeScript打包: 运行 'npm run build' 命令,将TypeScript代码编译为JavaScript代码。

服务器配置

MCP服务器需要配置在MCP客户端中,以便客户端能够找到并连接到该服务器。以下是配置示例,请根据您的操作系统选择相应的配置添加到MCP客户端的配置文件中(通常是JSON格式)。

注意: 以下配置信息为JSON格式,请复制到您的MCP客户端配置文件中,并替换 'your_api_key' 和 'your_api_userid' 为您从羽山数据获取的真实密钥和用户ID。

macOS/Linux 配置示例

"mcpServers": {
  "usense-corp": {
    "command": "npx",
    "args": [
      "-y",
      "mcp-server-usense-corp"
    ],
    "env": {
      "YUSHAN_API_KEY": "your_api_key",  // 替换为您的羽山数据API密钥
      "YUSHAN_API_USERID": "your_api_userid" // 替换为您的羽山数据用户ID
    }
  }
}

Windows 配置示例

"mcpServers": {
  "usense-corp": {
    "command": "cmd",
    "args": [
      "/c",
      "npx",
      "-y",
      "mcp-server-usense-corp"
    ],
    "env": {
      "YUSHAN_API_KEY": "your_api_key",  // 替换为您的羽山数据API密钥
      "YUSHAN_API_USERID": "your_api_userid" // 替换为您的羽山数据用户ID
    }
  }
}

配置参数说明:

  • '"usense-corp"': 服务器名称,您可以自定义,用于在MCP客户端中标识该服务器。
  • '"command"': 启动服务器的命令。 'npx' 用于执行本地安装的 npm 包,'cmd' 在 Windows 环境下使用。
  • '"args"': 传递给启动命令的参数。 '-y' 允许 'npx' 在执行前自动安装 'mcp-server-usense-corp' 包(如果尚未安装)。 'mcp-server-usense-corp' 是实际要执行的服务器程序。
  • '"env"': 设置环境变量,用于传递API密钥和用户ID等敏感信息给服务器程序。 'YUSHAN_API_KEY' 和 'YUSHAN_API_USERID' 是服务器程序读取的用于身份验证的环境变量名。

基本使用方法

  1. 启动MCP客户端: 确保您使用的LLM客户端或智能体助手支持MCP协议,并已正确配置上述服务器信息。
  2. 连接服务器: 在MCP客户端中选择或启用名为 '"usense-corp"' (或您自定义的服务器名称) 的MCP Server。客户端将根据配置信息自动连接到该服务器。
  3. 使用数据服务: 通过LLM客户端的功能,调用MCP Server提供的企业数据查询服务。具体的调用方式取决于羽山数据服务提供的工具和资源,以及您的LLM客户端的功能。 请参考羽山数据和您的LLM客户端的相关文档了解更详细的使用方法。

信息

分类

商业系统