MCP Statcan

🚀 统计加拿大API与数据库集成项目

本项目是一个FastMCP服务器项目，致力于集成统计加拿大（Statistics Canada）的API和数据库。其核心价值在于为用户提供便捷的统计加拿大数据访问、处理和存储功能，极大地提升了数据利用效率。

🚀 快速开始

本项目是集成统计加拿大（Statistics Canada）API和数据库的FastMCP服务器项目，能实现对统计加拿大数据的访问、处理和存储。以下是快速启动项目的步骤：

1. 按照安装指南完成项目的安装与配置。
2. 参考使用示例进行API操作和数据库操作。

✨ 主要特性

• API集成：支持通过StatCan API获取实时数据，确保数据的及时性和准确性。
• 数据库集成：支持将API数据存入SQLite数据库，并支持直接查询数据库，方便数据的持久化和检索。
• 模块化设计：采用FastMCP框架，便于扩展和维护，提高了项目的可维护性和可扩展性。
• 高效性能：使用uv作为包管理工具，提升安装效率，减少项目部署时间。

📦 安装指南

系统要求

• 操作系统：支持Windows、Mac/Linux。
• Python版本：3.10或更高。

安装步骤

1. 安装Python：

   • 下载地址：python.org
   • 安装时请勾选“将Python添加到PATH”。

2. 安装uv包管理工具：

   curl -fsSL https://astral.sh/uv/install.sh | bash  # Mac/Linux
   # 或者在Windows上：
   # curl.exe -fsSL https://astral.sh/uv/install.ps1 -o install.ps1; powershell -ExecutionPolicy Bypass -File install.ps1
   

3. 安装项目依赖：

   uv pip install fastmcp httpx pydantic
   

4. 克隆代码仓库：

   git clone https://github.com/Aryan-Jhaveri/mcp-statcan.git
   cd mcp-statcan
   

项目运行

# 启动服务器
uv run --with fastmcp --with httpx sh -c "cd mcp-statcan && python -m src.server"

配置Claude Desktop

1. 编辑配置文件：

   • 打开Claude桌面应用，进入设置界面（⌘ + ,）。
   • 在开发者选项中选择“编辑配置”。

2. 添加服务器配置： 替换/path/to/mcp-statcan为实际项目路径：

   {
     "mcpServers": {
       "StatCanAPI_DB_Server": {
         "command": "uv",
         "args": [
           "run",
           "--with", "fastmcp",
           "--with", "httpx", 
           "sh",
           "-c",
           "cd /path/to/mcp-statcan && python -m src.server"
         ]
       }
     }
   }
   

💻 使用示例

基础用法

# 搜索与就业相关的数据表
tables = await search_cancad_statistics()

# 获取实时统计数据
statistics_data = await fetch_statcan_data()

# 将API数据存入数据库
save_to_database(statistics_data)

# 直接查询数据库
query_results = database_query("SELECT * FROM statistics")

高级用法

# 这里可以根据实际的高级场景进行说明，例如复杂的数据处理或多表查询等
# 目前原文档未提供高级用法示例，可根据实际情况补充

📚 详细文档

更多详细信息请参考项目文档。

🔧 技术细节

项目结构

src/
├── config.py            # 配置加载（如数据库凭证、API基础URL）
├── server.py            # 主FastMCP服务器定义及工具注册
└── __init__.py          # 包初始化文件

已知问题与限制

• SSL验证：目前开发环境下关闭，建议生产环境启用，以保障数据传输的安全性。
• Claude行为：可能出现循环或多次REST调用的情况，使用时需留意。
• 数据校验：使用前请交叉核对官方统计加拿大来源数据，确保数据的准确性。
• 安全问题：查询验证基础，避免处理未信任输入，防止安全漏洞。
• 性能限制：部分接口在大数据请求时可能超时，可根据实际情况优化请求策略。

📄 许可证

原文档未提及许可证信息，若有相关内容可补充在此处。

👥 项目贡献者

• 主要开发者：Aryan Zarei
• 维护团队：统计加拿大开放数据小组