Explorium

🚀 探索者 MCP 服务器

探索者 MCP 服务器是一个基于模型上下文协议（MCP）的服务器，可与 Explorium API 进行交互。它为 AI 助手提供了访问 Explorium 企业数据和潜在客户查找功能的途径，极大地拓展了 AI 助手在企业场景中的应用能力。

🚀 快速开始

安装

要安装探索者 MCP 服务器，只需运行以下命令：

pip install explorium-mcp-server

本地运行

在项目根目录下运行以下命令启动服务器：

python src/explorium_mcp_server/__main__.py

✨ 主要特性

• 作为模型上下文协议（MCP）服务器，与 Explorium API 无缝交互。
• 使 AI 助手能够访问 Explorium 的企业数据和潜在客户查找功能。
• 提供 MCPTool 和 DataParser 等实用工具，方便与 API 交互和数据处理。

📦 安装指南

开发环境搭建

1. 克隆项目仓库：

   git clone https://github.com/explorium-ai/mcp-server.git
   cd mcp-server
   

2. 安装依赖项：

   pip install -r requirements.txt
   

3. 配置环境变量，编辑 .env 文件：

   APP_ENV=development
   APP_SECRET=your-secret-key
   

💻 使用示例

与 AI 助手的使用 - Claude Desktop

基础用法

要将探索者 MCP 服务器集成到 Claude Desktop 中，请按照以下步骤操作：

1. 安装必要的依赖项：

   pip install python-dotenv requests
   

2. 创建一个新脚本并添加以下代码：

   from explorium_mcp_server import tools
   
   def main():
       # 初始化 MCP 工具
       mcp_tool = tools.MCPTool()
       # 获取数据
       data = mcp_tool.fetch_data()
       print(data)
   
   if __name__ == "__main__":
       main()
   

3. 在终端中运行脚本：

   python your_script.py
   

工具介绍

探索者 MCP 服务器提供以下工具：

• MCPTool: 用于与 Explorium API 进行交互。
• DataParser: 用于解析和处理数据。

📚 详细文档

项目结构

explorer-mcp-server/
├── .env               # 本地环境变量文件
├── src/              # 源代码目录
│   └── explorium_mcp_server/
│       ├── __init__.py      # 包初始化文件
│       ├── __main__.py      # 程序入口点
│       ├── models/          # 数据模型和架构
│       └── tools/           # MCP 工具实现
├── tests/            # 测试套件
├── Makefile         # 开发快捷方式文件
└── README.md        # 项目文档

开发工作流

1. 设置环境如上所述。
2. 修改代码并保存更改。
3. 格式化代码：

   make format
   

4. 运行检查：

   make lint
   

5. 执行测试：

   make test
   

持续集成

项目使用 GitHub Actions 进行持续集成和交付。主工作流位于 .github/workflows/ci.yml，执行以下操作：

1. 版本检查：确保 pyproject.toml 中的版本号在合并到主分支之前更新。
2. 代码风格检查：使用 ruff 进行代码样式和格式验证。
3. 测试：执行测试套件并生成覆盖率报告。
4. 部署：将提交标签推送到 GitHub。

构建和发布

构建包

1. 更新 pyproject.toml 中的版本号（每个新版本都需要更新）。
2. 运行构建命令：

   uv build
   

此命令会在项目根目录下创建一个 dist/ 文件夹，包含生成的安装包。

发布到 PyPI

1. 确保已安装 twine：

   pip install twine
   

2. 上传构建好的包到 PyPI：

   twine upload dist/*
   

您需要提供 PyPI 凭据或配置 .pypirc 文件。

自动版本控制和标记

当代码合并到主分支时，CI 工作流会自动：

1. 使用 pyproject.toml 中的版本号为仓库创建标签。
2. 将标签推送到 GitHub。