AWS Qindex MCP Server

AWS Qindex MCP Server

AWS Qindex MCP Server 允許 AI 應用程序通過模型上下文協議 (Model Context Protocol) 安全且無縫地存取 Amazon Q Index 數據，幫助語言模型和智能助手執行自然語言的搜尋、檢索和分析企業文檔索引。

Author: awslabs


查看協議

什麼是 AWS Qindex MCP Server?

AWS Qindex MCP Server 是一個專門的伺服器元件，通過標準化的模型上下文協議 (Model Context Protocol, MCP) 提供 Amazon Q Index 的搜尋和數據檢索功能。它使用於 AI 代理、基於 LLM 的編碼助手和自動化工具，整合 Q Index 作為上下文數據來源，方便執行語義文檔搜索、回答索引語料的問題，以及利用企業知識進行生成式 AI 工作流。

如何配置

設置 AWS Qindex MCP Server:

  1. 先決條件：
    • 確保已安裝 Python（建議使用 uv）。
    • 擁有配置好的 AWS 配置檔/憑證，並具備訪問 Q Index 的權限。
    • 根據應用需求，使用 uvx 或作為 Docker 容器安裝 MCP Server。
  2. 添加到您的 MCP 客戶端配置： 在您的 MCP 客戶端配置文件中添加條目（例如 ~/.aws/amazonq/mcp.json，.cursor/mcp.json 等）： 
    {
  "mcpServers": {
    "awslabs.qindex-mcp-server": {
      "command": "uvx",
      "args": ["awslabs.qindex-mcp-server@latest"],
      "env": {
        "AWS_PROFILE": "your-aws-profile",
        "AWS_REGION": "your-aws-region",
        "FASTMCP_LOG_LEVEL": "ERROR"
      }
    }
  }
}
  3. 環境變量和權限：
    • 根據需要設置 AWS_PROFILE 和 AWS_REGION 的值。
    • 確保您的 IAM 用戶或角色可以訪問 Amazon Q Index API。
    • 可選地配置任何特定的 Q Index 標識符或您工作流所需的自定義環境變量。
  4. **測試連接：**使用 MCP 客戶端的介面檢查伺服器是否可發現並返回可用工具，路徑為 /tools/list。

如何使用

  1. 智能助手集成：
    • 通過您的 AI 編碼助手或聊天介面（例如 Amazon Q、Cursor、Windsurf、Claude Desktop）使用自然語言提示，調用從 Q Index 的搜索或檢索。
    • LLM 使用 MCP 協議向 Qindex 伺服器查詢相關文檔或答案。
  2. 直接調用工具：
    • 通過您的 MCP 客戶端，使用 tools/list 列出可用的功能（工具）。
    • 使用 tools/call 端點調用 Q Index 搜索操作，傳遞關鍵字或文檔過濾器等查詢參數。
    • 聊天示例："使用 Qindex MCP Server 搜尋 AWS Lambda 的最新架構指導。"
  3. 上下文補全：
    • 啟用後，來自 Q Index 的結果可以嵌入語言模型的上下文窗口，以提高代碼、文檔或研究成果的準確性和事實依據。
  4. 多代理工作流程：
    • 將 Qindex MCP Server 的響應與其他 MCP 伺服器（例如 AWS 文檔或成本分析）結合，進行複雜的跨領域推理和自動化。

主要特點

  • **實時語義搜索：**對企業的 Q Index 進行自然語言或關鍵字查詢。
  • **LLM 就緒的結構化結果：**返回結構化的上下文數據，隨時可以注入 LLM 提示或代理工作流。
  • **授權繼承：**利用現有的 AWS IAM 進行細顆粒且安全的數據訪問。
  • **企業知識整合：**無縫地將組織的 Q Index 知識帶入 AI 驅動的編碼助手和代理。
  • **工具發現和調用：**提供可探索、可組合的功能 (MCP 工具)，用於搜索、過濾和檢索索引內容。
  • **引用和參考：**結果可以包括來源/文檔元數據，實現準確的追蹤和審計。
  • **可與其他 MCP 伺服器組合：**靈活與其他上下文/數據提供商集成，支持全堆疊的 AI 開發。

使用案例

  • **企業知識搜索：**通過在經過策劃的 Q Index 上進行自然語言搜索，即時回答業務、工程或合規問題。
  • **研究助手：**檢索全企業最新的架構模式、安全指南或最佳實踐，以支持上下文感知的代碼生成。
  • **對話式問答：**為聊天機器人、虛擬助手或支持代理提供能力，使其能夠在權威的內部文檔中基於事實回應。
  • **自動化代碼生成：**使用來自 Q Index 的組織特定引用和最佳實踐，增強 LLM 代碼輸出。
  • **合規和安全審計：**快速查找相關政策和文檔以回應審計或合規查詢。
  • **自定義工作流程：**支持多工具鏈，其中從 Amazon Q Index 檢索的信息引導或約束其他與 MCP 集成的工具的行為。

常見問題

Q1: 運行 AWS Qindex MCP Server 需要哪些權限？
訪問 Amazon Q Index 數據，您的 AWS 配置檔或憑證必須擁有訪問相關 Q Index API 的權限（例如 qindex:Search 或類似的細顆粒權限）。請諮詢您的安全團隊以確保合規訪問。

Q2: 我可以將 Qindex MCP Server 用於多個 Q Index 或租戶嗎？
可以，您可以指定不同的 Q Index 標識符，或在您的 MCP 客戶端配置中設置多個條目，以根據需要將查詢路由到不同的 Q Index 數據源。

Q3: AWS Qindex MCP Server 如何處理敏感或受限數據？
數據訪問、過濾和授權是使用您的 AWS 安全上下文來強制執行的。只有擁有適當權限的用戶或角色才能檢索到相符的結果。

Q4: Qindex MCP Server 返回什麼格式或內容類型？
工具回應包括帶有 ID、片段、標題和文檔元數據的結構化 JSON 貨幣，選擇性包含完整文本，適合嵌入 LLM 上下文窗口或後續處理。

Q5: 如何排除連接或伺服器啟動的問題？
檢查您的 AWS 憑證是否已設置、區域是否正確，且您的 IAM 政策是否授予所需的 Q Index 權限。使用 MCP 客戶端的日誌（設置 FASTMCP_LOG_LEVEL=DEBUG）進行進一步診斷。