使用说明
数据集分析器MCP
作者：JJaniel 许可证：麻省理工学院 联系人： GitHub问题
该项目是一个为智能数据集分析而设计的模型上下文协议（MCP）服务器。它提供了一套工具来帮助您理解、清理和处理数据集。
请参阅 NEWS.md 项目更新日志文件。
如何使用此项目
本指南将引导您在本地计算机上设置和运行数据集分析器MCP服务器。
先决条件
在开始之前，请确保您的系统上安装了以下内容：
- Git： https://git-scm.com/downloads
- python （3.8或更高版本） https://www.python.org/downloads/
- 紫外线： （一个快速的Python包安装程序）你可以用
pip:pip install uv
第1部分：用户（运行项目）
如果您只想使用服务器分析自己的数据集，请按照以下步骤操作。
第一步：获取代码
使用以下命令将存储库克隆到本地计算机 git.打开终端或命令提示符并运行：
# Use this command for HTTPS (easiest)
git clone https://github.com/JJaniel/dataset-analyser.git
# Or use this command for SSH (if you have SSH keys set up with GitHub)
git clone git@github.com:JJaniel/dataset-analyser.git
这将创建一个名为的新文件夹 dataset-analyser。导航到其中：
cd dataset-analyser
步骤2：设置Python环境
最好的做法是创建一个虚拟环境来隔离项目依赖关系。
# Create a virtual environment using uv
uv venv
# Activate the environment
# On Windows:
source .venv/Scripts/activate
# On macOS/Linux:
source .venv/bin/activate
# Install the required Python packages
uv pip install -r requirements.txt
步骤3：配置数据集目录
此服务器从特定文件夹加载数据集。你需要通过设置一个名为的环境变量来告诉它你的数据集在哪里 DATASETS_DIR.
- 在Windows上（在命令提示符中）：
set DATASETS_DIR=C:\path\to\your\datasets - 在Windows上（在PowerShell中）：
$env:DATASETS_DIR="C:\path\to\your\datasets" - 在macOS/Linux上：
export DATASETS_DIR=/path/to/your/datasets
替换 C:\path\to\your\datasets 包含您的文件夹的实际绝对路径 .csv 文件夹。
步骤4：运行服务器
现在，您可以启动MCP服务器：
python main.py
服务器现在正在运行，并准备接受来自MCP兼容客户端的连接。
第2部分：对于贡献者（进行更改）
如果要修改代码并将更改贡献回主项目，请执行以下步骤。
步骤1：分叉存储库
转到项目的GitHub页面： https://github.com/JJaniel/dataset-analyser 点击“分叉右上角的“”按钮。这将在您自己的GitHub帐户下创建存储库的个人副本。
第二步：克隆你的叉子
从以下位置克隆存储库 你的 账户，而不是原件。替换 <your-username> 使用您的GitHub用户名。
git clone https://github.com/<your-username>/dataset-analyser.git
cd dataset-analyser
步骤3：创建新分支
对新分支进行更改以保持其组织性至关重要。
# Create a branch and switch to it
git checkout -b my-awesome-feature
替换 my-awesome-feature 为您的更改提供一个简短的描述性名称（例如。， add-parquet-support).
第四步：做出改变
按照“第1部分”中的描述设置环境，并使用您最喜欢的编辑器进行所需的代码更改。
第五步：承诺并推动你的改变
一旦你对你的更改感到满意，就用明确的信息提交它们，并将其推送到 叉子.
# Stage your changes
git add .
# Commit them with a descriptive message
git commit -m "feat: Add support for Parquet files"
# Push the changes to your fork on GitHub
git push origin my-awesome-feature
步骤6：创建Pull请求
转到GitHub上的分叉存储库。您将看到提示“比较并拉取请求“。单击它。这将带您进入一个页面，您可以在其中描述您的更改并将其提交给原始项目进行审核。
许可证
该项目根据MIT许可证获得许可。请参阅 许可证 文件以获取详细信息。
