Frequently Asked Questions about pymcp

Q: What is pymcp? A: pymcp is a Python project based on the FastMCP framework that allows AI agents to interact with MySQL databases. It provides a server-client architecture for querying, analyzing, and leveraging data.

Q: What is MCP? A: MCP stands for Model Context Protocol. It’s an open protocol that standardizes how applications provide context to Large Language Models (LLMs), enabling AI models to access external data sources and tools.

Q: What are the system requirements for pymcp? A: pymcp requires Python 3.13 or higher. You also need to install the necessary dependencies using pip install -r requirements.txt.

Q: How do I install pymcp? A: You can install pymcp by cloning the repository and running pip install -r requirements.txt in your terminal.

Q: How do I run the pymcp server? A: Navigate to the project directory in your terminal and run python main.py. The server will start on 0.0.0.0:8080 by default.

Q: How do I run the pymcp client? A: In a separate terminal, navigate to the project directory and run python client.py. The client will connect to the server and allow you to execute commands.

Q: How do I configure the MySQL connection settings? A: You can configure the MySQL connection settings in the src/env.py (for local environment) or src/env_dev.py (for development environment) files. You can set environment variables like APP_ENV to switch between environments.

Q: What tools are available in pymcp? A: The server provides tools like describe_tools (to list available tools) and query_mysql(sql: str) (to execute SQL queries).

Q: How do I execute a SQL query using pymcp? A: Use the query_mysql tool with the SQL query as a string. For example: query_mysql("SELECT * FROM users LIMIT 10;").

Q: Can I use pymcp with the UBOS platform? A: Yes, pymcp can be integrated with UBOS to provide AI agents with access to MySQL databases. UBOS offers tools for orchestrating AI agents and connecting them to enterprise data.

Q: How do I set the environment (local/development)? A: You can set the environment using the APP_ENV environment variable. For example, export APP_ENV=dev sets the environment to development.

Q: What if I encounter issues during installation or execution? A: Refer to the project’s README.md for detailed instructions and troubleshooting tips. You can also consult the pymcp documentation for further assistance.