使用说明

项目简介

Infactory MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器，它充当大型语言模型 (LLM) 与 Infactory API 之间的桥梁。通过此服务器，LLM 可以安全、便捷地访问和操作您在 Infactory 环境中的数据和功能，例如项目管理、查询程序执行、数据源管理以及用户和团队信息查询。

主要功能点

项目管理：支持列出、检索和创建 Infactory 项目。
查询程序：支持列出和执行 Infactory 查询程序。
数据源管理：支持列出、检索和创建 Infactory 数据源。
用户与团队管理：支持获取当前用户信息和列出团队信息。
标准 MCP 协议：遵循 MCP 协议，可与任何兼容 MCP 协议的客户端（如 Claude、Cursor 等）集成。

安装步骤

推荐使用 NPX (无需安装，快速启动):

确保您已安装 Node.js 18 或更高版本。
打开终端，运行以下命令即可启动服务器：
```
npx -y @infactory/infactory-mcp
```
启动时，请确保已设置 'NF_API_KEY' 环境变量 (Infactory API 密钥)。

使用 Docker (容器化部署):

确保您已安装 Docker。

打开终端，运行以下命令即可启动服务器：

docker run -i --rm \
  -e NF_API_KEY="your_api_key_here" \
  @infactory/infactory-mcp

请将 '"your_api_key_here"' 替换为您的 Infactory API 密钥。

服务器配置

要将 Infactory MCP Server 集成到 MCP 客户端（例如 Claude Desktop, Windsurf, Cursor），您需要在客户端的 MCP 配置文件中添加以下服务器配置信息。以下是配置示例，请根据您的实际使用方式选择对应的配置并添加到客户端的配置文件中。

NPX 启动配置示例:

{
  "version": "0.1",
  "mcpServers": {
    "infactory-mcp": {
      "command": "npx",  // 启动命令，使用 npx 运行
      "args": ["-y", "@infactory/infactory-mcp"], // 命令参数，指定要运行的 npm 包
      "env": {
        "NF_API_KEY": "nf-************************" // 环境变量，用于设置 Infactory API 密钥，请替换为您的实际密钥
      }
    }
  }
}

本地开发启动配置示例 (从源码构建后):

如果您从源码构建并希望本地启动服务器进行开发，可以使用以下配置，请将 'FULL_PATH_TO/infactory-mcp/dist/index.js' 替换为 'index.js' 文件的实际完整路径。

{
  "version": "0.1",
  "mcpServers": {
    "infactory-mcp": {
      "command": "node", // 启动命令，使用 node 运行
      "args": ["FULL_PATH_TO/infactory-mcp/dist/index.js"], // 命令参数，指定 index.js 文件的路径
      "env": {
        "NF_API_KEY": "nf-************************" // 环境变量，用于设置 Infactory API 密钥，请替换为您的实际密钥
      }
    }
  }
}

基本使用方法

配置完成后，您可以在支持 MCP 协议的 LLM 应用中使用自然语言指令与 Infactory 数据进行交互。以下是一些示例 Prompt：

"Show me a list of all my Infactory projects" (显示我的所有 Infactory 项目列表)
"Get the details for project proj-123abc" (获取项目 proj-123abc 的详细信息)
"Create a new project called 'Data Analysis' in team team-456xyz" (在团队 team-456xyz 中创建一个名为 'Data Analysis' 的新项目)
"List all query programs in project proj-123abc" (列出项目 proj-123abc 中的所有查询程序)
"Execute query program qp-789def" (执行查询程序 qp-789def)
"Tell me about myself (my user account)" (告诉我关于我自己的信息 (我的用户帐户))

关键词