文档搜索服务器

一个集成GroundX RAG平台的MCP服务器,使AI助手能够从文档集合中搜索和检索信息。

  • by Jeevanpradhan571
  • Python
  • 本地部署
  • 更新于
在 GitHub 查看 jeevanpradhan571/mcp-groundx-rag-server

使用说明

MCP GroundX RAG集成:基于AI的文档搜索服务器

与GroundX RAG平台集成的模型上下文协议(MCP)服务器,使AI助手能够从文档集合中搜索和检索信息。

🚀 特性

  • RAG集成:与GroundX的文档搜索功能无缝集成
  • MCP协议:AI工具集成的标准协议
  • 语义搜索:使用向量嵌入进行高级文档检索
  • 实时查询:快速、响应迅速的文档搜索
  • 安全的API管理:基于环境的配置

🛠️ 使用的技术

  • Python 3 -核心编程语言
  • FastMCP -MCP服务器框架
  • GroundX SDK -文档搜索和RAG平台
  • python dotenv -环境变量管理

📋 先决条件

  • Python 3.7+
  • GroundX帐户和API密钥
  • Git

🔧 安装

  1. 克隆存储库

    git clone <your-repo-url>
    cd MCP
    
  2. 安装依赖项

    pip install mcp-server-fastmcp groundx python-dotenv
    
  3. 设置环境变量

    cp env.example .env
    

    编辑 .env 文件并添加GroundX API密钥:

    GROUNDX_API_KEY=your_groundx_api_key_here
    

🚀 用法

  1. 启动MCP服务器

    python3 server.py
    
  2. 与MCP客户端连接 服务器提供了一个名为 search_doc_for_rag_context 它接受查询字符串并返回相关的文档摘录。

📁 项目结构

MCP/
├── server.py          # Main MCP server implementation
├── .env               # Environment variables (not in repo)
├── env.example        # Example environment file
├── .gitignore         # Git ignore rules
├── requirements.txt   # Python dependencies
└── README.md          # This file

🔧 配置

环境变量

  • GROUNDX_API_KEY:您的GroundX API密钥(必需)

GroundX数据库

服务器已配置为搜索GroundX数据库ID 19859。要使用其他数据库,请执行以下操作:

  1. 更新 id 参数在 server.py:
    response = client.search.content(
        id=YOUR_DATABASE_ID,  # Change this
        query=query,
        n=10,
    )
    

🛠️ api参考

MCP工具: search_doc_for_rag_context

参数:

  • query (string):用于文档检索的搜索查询

退货:

  • string:GroundX数据库的相关文件摘录

例子:

# Query for aircraft specifications
result = search_doc_for_rag_context("MIG 29 aircraft dimensions")

🔒 安全

  • API键存储在环境变量中(不存储在代码中)
  • .env 文件被排除在版本控制之外
  • 使用 env.example 作为配置模板

🤝 贡献

  1. 分叉存储库
  2. 创建要素分支(git checkout -b feature/amazing-feature)
  3. 提交您的更改(git commit -m 'Add amazing feature')
  4. 推到分支(git push origin feature/amazing-feature)
  5. 打开拉取请求

📄 许可证

此项目根据MIT许可证获得许可-请参阅 许可证 文件以获取详细信息。

🙏 致谢

📞 支持

对于问题和疑问: