Release v0.0.1

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,35 @@
+---
+name: Bug report
+about: Help us fix it by providing detailed information about the issue
+title: "[BUG]"
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Log file / Error Message:**
+Paste any relevant logs or error messages here
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[FEAT]"
+labels: feature
+assignees: ''
+
+---
+
+**Summary**
+What change you think needs making.
+
+**Motivation**
+Please give examples of your use case, e.g. when would you use this.
+
+**Proposal**
+How do you think this should be implemented?
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,14 @@
+## Overview
+<!-- Provide a brief description of what this PR does -->
+
+## Key Changes
+<!-- List the main changes made in this PR -->
+- 
+- 
+
+## Related Issues
+<!-- Link to related issues using "Fixes #123", "Closes #456", or "Relates to #789" -->
+- 
+
+## Additional context
+<!-- Any additional information that reviewers should know -->

.github/workflows/ci.yml

@@ -0,0 +1,56 @@
+name: CI
+
+on:
+  pull_request:
+    branches: [ develop ]
+  push:
+    branches: [ develop ]
+
+jobs:
+  lint-and-test:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v3
+
+    - name: Set up Python
+      run: uv python install
+
+    - name: Install dependencies
+      run: uv sync --all-groups
+
+    - name: Run ruff check
+      run: uv run ruff check
+
+    - name: Run ruff format check
+      run: uv run ruff format --check .
+
+    - name: Run tests with pytest
+      run: uv run pytest
+
+
+  test-matrix:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v3
+
+    - name: Set up Python ${{ matrix.python-version }}
+      run: uv python install ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: uv sync --all-groups
+
+    - name: Run tests
+      run: uv run pytest

.github/workflows/release.yml

@@ -0,0 +1,39 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+permissions:
+  contents: write
+  id-token: write
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v3
+
+    - name: Set up Python
+      run: uv python install
+
+    - name: Install dependencies
+      run: uv sync --group dev
+
+    - name: Build package
+      run: uv build
+
+    - name: Publish to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+
+    - name: Create GitHub Release
+      uses: softprops/action-gh-release@v2
+      with:
+        generate_release_notes: true

.gitignore

@@ -5,6 +5,7 @@ __pycache__/
 
 # C extensions
 *.so
+.idea
 
 # Distribution / packaging
 .Python

.pre-commit-config.yaml

@@ -0,0 +1,10 @@
+repos:
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  # Ruff version.
+  rev: v0.12.7
+  hooks:
+    # Run the linter.
+    - id: ruff-check
+      args: [ --fix ]
+    # Run the formatter.
+    - id: ruff-format

.python-version

@@ -0,0 +1 @@
+3.10

CONTRIBUTING.rst

@@ -0,0 +1,91 @@
+==============================
+Contributing to OpenStack MCP Server
+==============================
+
+About the Project
+==================
+
+OpenStack MCP Server is a project that integrates various OpenStack functionalities with the Model Context Protocol (MCP), enabling LLM-powered management of OpenStack resources.
+
+How to Contribute
+=================
+
+First, thank you for reading this document to contribute to our OpenStack MCP Server project. The following content explains the guidelines for contributing to our project, how to set up the development environment, and coding style guidelines.
+
+PR Guidelines
+=============
+
+Issue Report
+------------
+
+Before submitting code for new features (and this also applies to some complex bug fixes), please first raise a **Feature request** or **Bug report**.
+
+Review Process
+--------------
+
+- This project currently uses main and develop branches as the base. PRs to the main branch are restricted to the develop branch.
+- All patches must be first merged into the develop branch and require approval from at least 2 code reviewers to be merged into develop.
+
+Commit Message
+--------------
+
+We use the `Conventional Commits <https://www.conventionalcommits.org/en/v1.0.0/>`_ convention for writing commit messages.
+
+Format::
+
+    <type>[optional scope]: <description>
+    [optional body]
+    [optional footer(s)]
+
+**Example**::
+
+    feat(compute): implement server management tools
+
+    Add Compute server listing and detail retrieval functionality
+    for MCP clients with proper error handling and OpenStack SDK integration.
+
+    - Add get_compute_servers tool
+    - Add get_server_details tool  
+    - Implement server status filtering
+    - Add comprehensive error handling
+
+    Closes #123
+
+Development Environment
+=======================
+
+The following content is a guide for contributors to set up a development environment in their local environment.
+
+Prerequisites
+=============
+
+- This project uses uv to manage Python packages. Please set up an environment where you can use uv in your local environment for development environment setup. `Reference <https://docs.astral.sh/uv/getting-started/installation/>`_
+- We use ``python3.10`` as the default version. This is to ensure compatibility with other OpenStack projects.
+
+UV Package Build
+----------------
+
+.. code-block:: bash
+
+    uv sync --all-groups
+
+Pre-commit
+----------
+
+Code style is managed uniformly through ruff. We recommend setting up pre-commit hooks so that auto-formatting is applied at the commit stage.
+
+.. code-block:: bash
+
+    pre-commit install
+
+Testing
+=======
+
+Unit Tests
+----------
+
+All patches related to feature additions must implement unit test code. This project uses Pytest as the testing library, and if the project has been built successfully, you can run tests with the following command:
+
+.. code-block:: bash
+
+    uv run pytest

README.md

@@ -1,2 +1,102 @@
 # python-openstackmcp-server
-openstack mcp server
+
+Openstack mcp server is a [Model Context Protocol (MCP)](https://modelcontextprotocol.io/docs/getting-started/intro) server that provides an interface for AI assistants to interact with OpenStack services.
+
+```mermaid
+flowchart LR
+    AI[AI Assistant] <-->|MCP Protocol| Server[OpenStack MCP Server]
+    Server <-->|OpenStack SDK| SDK[OpenStack SDK]
+    SDK <-->|REST API| Cloud[OpenStack Cloud]
+```
+
+# Table of Contents
+- [Table of Contents](#table-of-contents)
+- [Features](#features)
+- [Quick Start with Claude Desktop](#quick-start-with-claude-desktop)
+  - [Requirements](#requirements)
+  - [Using python](#using-python)
+  - [Using uvx](#using-uvx)
+  - [Contributing](#contributing)
+  - [License](#license)
+
+# Features
+- **MCP Protocol Support**: Implements the Model Context Protocol for AI assistants.
+- **Compute Tools**: Manage OpenStack compute resources (servers, flavors).
+- **Image Tools**: Manage OpenStack images.
+- **Identity Tools**: Handle OpenStack identity and authentication.
+- **Network Tools**: Manage OpenStack networking resources.
+- **Block Storage Tools**: Manage OpenStack block storage resources.
+
+# Quick Start with Claude Desktop
+
+Get started quickly with the OpenStack MCP server using Claude Desktop
+
+## Requirements
+- Python 3.10 or higher
+- OpenStack credentials configured in `clouds.yaml` file
+- Claude Desktop installed
+
+1. **Create or update your `clouds.yaml` file with your OpenStack credentials.**
+
+   Example `clouds.yaml`:
+   ```yaml
+   clouds:
+     openstack:
+       auth:
+         auth_url: https://your-openstack-auth-url.com
+         username: your-username
+         password: your-password
+         project_name: your-project-name
+         user_domain_name: Default
+         project_domain_name: Default
+       region_name: your-region
+       interface: public
+       identity_api_version: 3
+   ```
+
+2. **Create or update your Claude Desktop configuration file**:
+   - **macOS**: Edit `$HOME/Library/Application Support/Claude/claude_desktop_config.json`
+   - **Windows**: Edit `%APPDATA%\Claude\claude_desktop_config.json`
+   - **Linux**: Edit `$HOME/.config/Claude/claude_desktop_config.json`
+
+### Using python
+
+   ```json
+   {
+     "mcpServers": {
+       "openstack-mcp-server": {
+         "command": "/path/to/your/python",
+         "args": [
+           "python-openstackmcp-server"
+         ],
+         "env" : {
+           "OS_CLIENT_CONFIG_FILE": "/path/to/your/clouds.yaml"
+         }
+       }
+     }
+   }
+   ```
+
+### Using uvx
+
+   ```json
+   {
+     "mcpServers": {
+       "openstack-mcp-server": {
+         "command": "uvx",
+         "args": [
+           "python-openstackmcp-server"
+         ],
+         "env" : {
+           "OS_CLIENT_CONFIG_FILE": "/path/to/your/clouds.yaml"
+         }
+       }
+     }
+   }
+   ```
+
+# Contributing
+Contributions are welcome! Please see the [CONTRIBUTING](CONTRIBUTING.rst) file for details on how to contribute to this project.
+
+# License
+This project is licensed under the Apache License 2.0. See the [LICENSE](LICENSE) file for details.