aide-mcp-server

NetApp AI Data Engine（AIDE）MCP 服务

说明

netapp-aide-mcp 是一个 MCP 服务（Python 包），通过 MCP 提供 NetApp AI Data Engine 的 RAG（检索增强生成）搜索功能。该服务提供名为 netapp_data_engine_search 的工具，可使用 AIDE 的 RAG API 搜索文档。此 RAG API 实现了基于向量的语义相似度搜索引擎，可根据提供的查询检索相关文档。

说明

此 MCP 服务使用 stdio 传输，因此是一个“本地 MCP 服务”。

快速开始

前提条件

• Python >= 3.10
• uv（自动管理所有安装）

配置

运行服务前，需要在主目录中创建 .netapp 文件，并添加必要的配置。

1. 创建 .netapp 文件：

   • 打开终端或文件资源管理器。
   • 转到主目录（例如，类 Unix 系统中的 ~，或 Windows 中的 C:\Users\YourUsername）。
   • 创建一个名为 .netapp 的新文件。

2. 添加 JSON 配置：

   • 在文本编辑器中打开 .netapp 文件。
   • 添加以下 JSON 配置，并将示例值替换为你自己的值：

   PKCE 流程：（如果你的计算机上有浏览器，建议使用此流程）

   {
     "rag_search_api_endpoint_url": "https://example.com/api",
     "verify_ssl": true,
     "auth_flow": "pkce",
     "token_request_endpoint_url": "https://login.microsoftonline.com/<tenant>/oauth2/v2.0/authorize",
     "token_exchange_endpoint_url": "https://login.microsoftonline.com/<tenant>/oauth2/v2.0/token",
     "token_request_params": {
       "client_id": "your_client_id",
       "redirect_uri": "http://localhost:8888",
       "scope": "api://your-app/.default",
       "use_pkce": true,
       "auth_timeout_seconds": 300
     }
   }
   

   设备代码流程：（如果你的计算机上没有浏览器，请使用此流程。日志中会显示一个短代码；复制该代码，在任何设备上打开提供的验证 URL，并输入代码以完成身份验证。）

   {
     "rag_search_api_endpoint_url": "https://example.com/api",
     "verify_ssl": true,
     "auth_flow": "device_code",
     "device_code_endpoint_url": "https://login.microsoftonline.com/<tenant>/oauth2/v2.0/devicecode",
     "token_request_endpoint_url": "https://login.microsoftonline.com/<tenant>/oauth2/v2.0/token",
     "token_request_params": {
       "client_id": "your_client_id",
       "scope": "api://your-app/.default"
     }
   }
   

   仅支持 PKCE（基于 Web）和设备代码流程。

3. 设置文件权限：

   • 出于安全考虑，请确保其他用户或用户组无法读取 .netapp 文件。

   • 在类 Unix 系统上，可以使用以下命令设置权限：

     chmod 600 ~/.netapp
     

   • 在 Windows 上，可以通过文件属性对话框设置文件权限。

提示

仓库中的 Examples 文件夹包含一个 .netapp.example 文件，其中提供了 .netapp 文件的配置示例。创建自己的 .netapp 文件时，可以参考此文件。

使用 uvx 运行

你可以立即运行 MCP 服务，无需全局安装任何内容。

说明

身份验证会在首次调用工具时启动，而不是在服务启动时启动。首次调用工具时：如果使用 PKCE 流程，将打开浏览器窗口；如果使用设备代码流程，设备代码详情将打印在 MCP 服务的控制台日志中。

运行 PyPI 上的预构建包

# Run the latest stable version
uvx --from netapp-aide-mcp server

# Run a specific version
uvx --from netapp-aide-mcp==1.0.0 server

• server 脚本会启动 MCP 服务

从源代码构建并运行

# Clone the repo
git clone https://github.com/NetApp/aide-mcp-server
cd aide-mcp-server

# Optional: check out a specific release
# git checkout tags/release-v1.0.0

# Retrieve the directory path for the cloned repo
export AIDE_MCP_REPO_PATH=$(pwd)

uvx --from $AIDE_MCP_REPO_PATH server

• server 脚本会启动 MCP 服务

JSON 配置示例

要在 MCP 客户端中使用此 MCP 服务，需要将客户端配置为使用此服务。对于许多客户端（例如 VS Code、Claude Desktop 和 LMStudio），这需要编辑 JSON 格式的配置文件（通常名为 mcp.json）。以下是一个示例。有关具体的格式要求，请参阅 MCP 客户端的文档。

说明

大多数 MCP 客户端会负责启动 MCP 服务。通常无需自行启动服务。与往常一样，有关客户端如何处理 MCP 服务的详情，请参阅相应文档。

{
	"servers": {
		"netapp-aide-mcp": {
			"type": "stdio",
			"command": "uvx",
			"args": [
				"--from",
				"netapp-aide-mcp",
				"server"
			]
		}
	}
}

故障排除

• 确保 .netapp 文件存在且格式正确。
• 检查是否已安装 Python 3.10+ 和 uv。
• 确保 MCP 客户端兼容 stdio 传输；大多数桌面客户端（例如 VS Code、Claude Desktop、LMStudio）都兼容，但某些托管客户端不兼容。
• 如果使用设备代码身份验证流程，请检查 MCP 服务控制台日志中的设备代码详情。首次调用工具时，设备代码详情会打印到日志中。
• 如果客户端未调用 MCP 工具，请尝试在提示词中添加“Be sure to use NetApp AIDE”。

MCP Registry 元数据

mcp-name: io.github.NetApp/aide-mcp-server

许可证

根据 BSD 3-Clause License 的条款分发（请参阅代码库中的 LICENSE 文件）。