Stata MCP

🚀 Stata-MCP

Stata-MCP is a tool for integrating Stata and Python in VS Code/Cursor, aiming to help data scientists streamline their data analysis and modeling workflows.

🚀 Quick Start

Stata-MCP is designed to seamlessly integrate Stata and Python within the VS Code/Cursor environment, enabling data scientists to perform efficient data analysis and modeling.

✨ Features

• Run Stata code within the VS Code/Cursor environment.
• Seamlessly integrate Stata data with Python workflows.
• Provide syntax highlighting and intelligent code completion for Stata scripts.
• Include an MCP (Mimic Control Panel) interface to enhance data processing capabilities.

📦 Installation

Installation Steps

1. Open VS Code/Cursor and access the Extensions Marketplace:
   • Press Ctrl+Shift+X or select "Extensions" from the menu bar.
2. Search for "Stata-MCP" in the search bar and install the latest version.

Install Dependencies

• Python 3.11 or higher: Required to run the MCP backend service.
• uv: A fast Python package management tool for environment configuration.

💻 Usage Examples

Configuration Guide

Create an MCP Environment

# Windows:
py -3.11 -m venv .venv

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

Start the MCP Service

uvicorn deepecon.stata_mcp.main:app --reload

Configuration File

Create a stata_mcp_config.yml file in the project root directory and add the following content:

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

Basic Usage

Start the Stata Service

After starting the MCP backend service, run the following command in the VS Code/Cursor terminal:

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

Use the MCP Interface

Utilize the interactive console provided by MCP for data processing and analysis, supporting the following functions:

• Data import and export
• Variable transformation and manipulation
• Model development and evaluation
• Result output and visualization

📚 Documentation

Troubleshooting

Common Issues

1. Service fails to start
   • Check if the Python version is 3.11 or higher.
   • Ensure that the uv tool is installed.
2. Dependency errors
   • Reinstall using the following command:

     pip install --upgrade deepecon-stata-mcp
     

3. Configuration file issues
   • Check if the stata_mcp_config.yml file is correctly formatted.
   • Ensure that the data and code paths are valid.

Common Installation Issues

1. Permission issues
   • Run the terminal as an administrator on Windows.
   • Use sudo to elevate privileges on macOS/Linux.
2. Environment variable configuration errors
   • Check if the paths for Python and uv are correctly added to the system PATH.
3. Network connectivity issues
   • Ensure that you can access the necessary data storage locations and internet resources.

Troubleshooting Guide

• Network problems
  1. Check if the network connection is stable.
  2. Verify that there are no firewalls or proxies blocking access to the service.
• Data loading failures
  1. Ensure that the data files exist and the paths are correct.
  2. Check if the file permissions allow reading.
• Service startup failures
  1. Check the error logs for detailed information.
  2. Confirm that the port is not occupied:

     netstat -ap | grep 8000
     

📄 License

This project is licensed under the MIT License. Please refer to the LICENSE file for detailed licensing information.

🙏 Acknowledgments

We would like to thank the following contributors and dependencies:

• List of contributors
• List of open-source libraries and their links

For further assistance, please refer to the official documentation or join our discussion group.