stata-mcp

🚀 Stata - MCP

Stata - MCP 是一款用于在 VS Code/Cursor 中集成 Stata 和 Python 的工具，旨在助力数据科学家更高效地开展数据分析和建模工作流。

🚀 快速开始

Stata - MCP 可帮助你在 VS Code/Cursor 环境下无缝结合 Stata 和 Python 进行数据分析。以下为你介绍使用前的安装和配置步骤。

✨ 主要特性

• 支持在 VS Code/Cursor 环境中运行 Stata 代码。
• 允许将 Stata 数据与 Python 工作流无缝结合。
• 提供对 Stata 脚本的语法高亮和智能感知功能。
• 内置 MCP（Mimic Control Panel）接口以增强数据处理能力。

📦 安装指南

安装步骤

1. 打开 VS Code/Cursor，进入扩展市场：
   • 按 Ctrl + Shift + X 或在菜单栏选择 "Extensions"。
2. 在搜索栏中输入 "Stata - MCP" 并安装最新版本。

安装依赖项

• Python 3.11 或更高版本：用于运行 MCP 后端服务。
• uv：快速的 Python 包管理工具，用于环境配置。

安装 Python

下载并安装最新版本的 Python 3.11 或更高版本：Python 下载页面

安装 uv

使用以下命令进行安装：

pip install uv

💻 使用示例

基础用法

配置 MCP 环境

创建 MCP 环境：

# Windows:
py -3.11 -m venv .venv

# macOS/Linux:
python3.11 -m venv .venv

启动 MCP 服务

uvicorn deepecon.stata_mcp.main:app --reload

配置文件

在项目根目录创建 stata_mcp_config.yml 文件，添加以下内容：

data_root:
    local: ./data/
    remote: s3://my-bucket/data/
code_root:
    scripts: ./scripts/
    models: ./models/

高级用法

启动 Stata 服务

启动 MCP 后端服务后，在 VS Code/Cursor 的终端中运行：

.("./path/to/script.do")

使用 MCP 接口

通过 MCP 提供的交互式控制台进行数据处理和分析，支持以下功能：

• 数据导入与导出
• 变量变换与操作
• 模型开发与评估
• 结果输出与可视化

📚 详细文档

配置 MCP 环境

1. 创建虚拟环境：

python -m venv mcp_env

2. 激活虚拟环境并安装依赖项：

source mcp_env/bin/activate  # macOS/Linux
.\mcp_env\Scripts\activate  # Windows
pip install deepecon-stata-mcp

启动 MCP 服务

在激活的虚拟环境中启动服务：

uvicorn deepecon.stata_mcp.main:app --reload

🔧 技术细节

故障排除

常见问题

1. 服务无法启动
   • 检查 Python 版本是否为 3.11 或更高。
   • 确保安装了 uv 工具。
2. 依赖项错误
   • 使用以下命令重新安装：

pip install --upgrade deepecon-stata-mcp

3. 配置文件问题
   • 检查 stata_mcp_config.yml 文件格式是否正确。
   • 确保数据和代码路径有效。

常见安装问题

1. 权限问题
   • 在 Windows 上以管理员身份运行终端。
   • 在 macOS/Linux 上使用 sudo 提升权限。
2. 环境变量配置错误
   • 检查 Python 和 uv 的路径是否正确添加到系统 PATH 中。
3. 网络连接问题
   • 确保可以访问必要的数据存储位置和互联网资源。

故障排除指南

1. 网络问题
   • 检查网络连接是否正常。
   • 查看是否有防火墙或代理阻止访问服务。
2. 数据加载失败
   • 确保数据文件存在且路径正确。
   • 检查文件权限是否允许读取。
3. 服务启动失败
   • 查看错误日志以获取详细信息。
   • 确认端口未被占用：

netstat -ap | grep 8000

📄 许可证

本项目采用 MIT 许可证。请查看 LICENSE 文件以了解详细许可信息。

致谢

感谢以下贡献者和依赖项：

• 贡献者名单
• 开源库列表及其链接

如需进一步帮助，请参考 官方文档 或加入我们的讨论组。