Getting started

Learn how to install and configure PyMAPDL-MCP, and how to contribute to the project.

• Installation
  • Check prerequisites
  • Install from PyPI
  • Install from source
  • Install development dependencies
  • Verify installation
  • Next steps
• IDE and client configuration
  • Claude Code
  • Visual Studio Code
  • Claude Desktop
  • General MCP clients
  • Claude Code versus Visual Studio Code
  • Advanced configuration
  • Next steps
• Quick start
  • Launch PyMAPDL-MCP
  • Connect to your IDE or client
  • Follow the basic workflow
  • Consider example use cases
  • Next steps
• Contributing
  • Answer discussions
  • Post issues
  • Next steps
• Write documentation
  • Understand the benefits of documentation
  • Understand documentation types
  • Use RST format
  • Set up documentation locally
  • Edit an existing page
  • Create a page
  • Write good documentation
  • Document code
  • Build documentation
  • Test documentation
  • Check documentation quality
  • Common documentation issues
  • Submit documentation changes
  • Use the documentation template
  • View resources
  • Earn recognition
  • See also
• Develop PyMAPDL-MCP
  • Architecture
  • Check prerequisites
  • Clone the repository
  • Set up your development environment
  • Explore the project structure
  • Follow the development workflow
  • Follow code conventions
  • Add a new tool
  • Add or modify documentation
  • Run tests
  • Get help
  • Submit your work
  • Follow PR guidelines
  • Earn recognition
  • See also