MCP-OpenStack-Ops copilot-instructions.md

GitHub Copilot Instructions

🚫 CRITICAL RESTRICTIONS - ALWAYS ENFORCE

Never Execute These Operations Directly:

• Git operations: Never run git add, git commit, git push, git pull, git tag, or any Git commands
• Docker operations: Never run docker build, docker run, docker-compose up/down, docker push, or any Docker commands
• Instead: Always ask the user to execute these commands manually

Python Execution Requirements:

• MANDATORY: Always use .venv/bin/python for all Python execution
• MANDATORY: Always use .venv/bin/pip for all package management
• NEVER use: python, python3, /usr/bin/python, pip, pip3, or system Python/pip
• Example: Use .venv/bin/python -m mcp_openstack_ops instead of python -m mcp_openstack_ops
• Example: Use .venv/bin/pip install package instead of pip install package

MCP Tool Safety Control Requirements:

• MANDATORY: When adding new MCP tools with modify operations, always use @conditional_tool decorator
• MANDATORY: Verify that ALLOW_MODIFY_OPERATIONS=false properly hides modify tools from registration
• NEVER use: @mcp.tool() for operations that can modify/delete OpenStack resources
• Always test: Tool visibility with both ALLOW_MODIFY_OPERATIONS=true and ALLOW_MODIFY_OPERATIONS=false
• Pattern: Read-only tools use @mcp.tool(), modify tools use @conditional_tool

---

Architecture Overview

This is an MCP (Model Context Protocol) Server for OpenStack Operations - a Python service providing real-time OpenStack cluster management through 24+ tools. The architecture follows a layered pattern:

• src/mcp_openstack_ops/functions.py (3000+ lines): Core OpenStack SDK operations with connection caching
• src/mcp_openstack_ops/mcp_main.py (1400+ lines): FastMCP tool definitions and conditional safety system
• src/mcp_openstack_ops/prompt_template.md: AI assistant behavior guide with tool patterns