mcp-instana 0.1.1__tar.gz → 0.2.0__tar.gz

mcp_instana-0.2.0/.bob/mcp.json

@@ -0,0 +1,3 @@
+{
+  "mcpServers": {}
+}

mcp_instana-0.2.0/.github/workflows/ci.yml

@@ -0,0 +1,127 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main, test-ci ]
+
+jobs:
+  lint-and-test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.11']
+    
+    steps:
+      - uses: actions/checkout@v4
+      
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          
+      - name: Install uv
+        run: pip install uv
+        
+      - name: Install dependencies
+        run: uv sync --all-extras
+        
+      - name: Run ruff check
+        run: uv run ruff check .
+        
+      - name: Run unit tests with verbose output
+        run: |
+          # Set environment variables to handle missing SDK modules gracefully
+          export PYTHONPATH=${{ github.workspace }}
+          export PYTHONUNBUFFERED="1"
+          export DISABLE_REAL_API_CALLS="true"
+          export CI="true"
+          
+          # Run tests and filter out expected import errors
+          # Note: Some Instana SDK modules may not be available in CI environment
+          # but tests are designed to handle this gracefully
+          uv run test -v 2>&1 | sed '/Error importing Instana SDK/d' || true
+        
+      - name: Run unit tests with coverage
+        run: |
+          # Set environment variables to handle missing SDK modules gracefully
+          export PYTHONPATH=${{ github.workspace }}
+          export PYTHONUNBUFFERED="1"
+          export DISABLE_REAL_API_CALLS="true"
+          export CI="true"
+          
+          # Run tests with coverage and filter out expected import errors
+          # Note: Some Instana SDK modules may not be available in CI environment
+          # but tests are designed to handle this gracefully
+          uv run test-coverage 2>&1 | sed '/Error importing Instana SDK/d' || true
+        
+      - name: Check environment for E2E tests
+        run: |
+          echo "Checking environment..."
+          pwd
+          ls -la
+          echo "Python version:"
+          python --version
+          echo "UV version:"
+          uv --version
+          echo "Checking test directories:"
+          ls -la tests/
+          ls -la tests/e2e/
+          echo "Checking source directories:"
+          ls -la src/
+        
+      - name: Run E2E mocked tests
+        env:
+          INSTANA_API_TOKEN: "test_token"
+          INSTANA_BASE_URL: "https://test.instana.io"
+          PYTHONPATH: ${{ github.workspace }}
+          PYTHONUNBUFFERED: "1"
+          DISABLE_REAL_API_CALLS: "true"
+          CI: "true"
+        run: |
+          echo "Running E2E mocked tests..."
+          
+          # Run E2E tests with mocked environment
+          uv run -m pytest tests/e2e/ -m "mocked" -v --tb=short --maxfail=10 || {
+            echo "E2E tests failed. Checking for specific errors..."
+            uv run -m pytest tests/e2e/ -m "mocked" -v --tb=long --maxfail=5
+            exit 1
+          }
+        
+      - name: Run E2E tests with coverage
+        env:
+          INSTANA_API_TOKEN: "test_token"
+          INSTANA_BASE_URL: "https://test.instana.io"
+          PYTHONPATH: ${{ github.workspace }}
+          PYTHONUNBUFFERED: "1"
+          DISABLE_REAL_API_CALLS: "true"
+          CI: "true"
+        run: |
+          echo "Running E2E tests with coverage..."
+          
+          # Run E2E tests with coverage
+          uv run -m pytest tests/e2e/ -m "mocked" --cov=src --cov-report=html --cov-report=term-missing -v --maxfail=10 || {
+            echo "E2E tests with coverage failed. Checking for specific errors..."
+            uv run -m pytest tests/e2e/ -m "mocked" -v --tb=long --maxfail=5
+            exit 1
+          }
+        
+      - name: Upload coverage reports as artifacts
+        uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: coverage-reports
+          path: |
+            htmlcov/
+            .coverage
+          retention-days: 30
+          
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v4
+        with:
+          file: ./htmlcov/coverage.xml
+          flags: unittests
+          name: codecov-umbrella
+          fail_ci_if_error: false
+          verbose: true

{mcp_instana-0.1.1 → mcp_instana-0.2.0}/CONTRIBUTING.md

@@ -5,7 +5,8 @@
 - [Contributing to MCP-Instana](#contributing-to-mcp-instana)
 - [Prerequisites](#prerequisites)
 - [Steps to Build a New MCP Tool](#steps-to-build-a-new-mcp-tool)
-  - [1. Set Up Your Development Environment](#1-set-up-your-development-environment)
+  - [1. Fork this repo](#1-fork-this-repo)
+  - [2. Set Up Your Development Environment](#2-set-up-your-development-environment)
   - [3. Create a New MCP Tools Module](#3-create-a-new-mcp-tools-module)
   - [4. Implement the MCP Tools class](#4-implement-the-mcp-tools-class)
   - [5. Write API tool Description precisely](#5-write-api-tool-description-precisely)
@@ -32,23 +33,36 @@ This guide provides step-by-step instructions for building a new MCP (Model Cont
 
 ### Steps to Build a New MCP Tool
 
-#### 1. Set Up Your Development Environment
+#### 1. Fork this repo
+
+To begin development, you’ll need your own copy of the repository:
+
+- Go to the GitHub page of this repository.
+- Click the Fork button in the top-right corner.
+- Select your personal GitHub account (or your organization’s account) as the destination.
+- GitHub will create a forked copy of the repository under your account, e.g. https://github.com/<Your GitHub Username>/mcp-instana
+
+#### 2. Set Up Your Development Environment
 
 ```bash
 # Clone the repository
-git clone https://github.com/instana/mcp-instana.git
+git clone https://github.com/<Your GitHub Username>/mcp-instana.git
 cd mcp-instana
 
 # Set up the environment
 uv sync
+
+# Alternative: Install from PyPI
+pip install mcp-instana
 ```
+
 #### 3. Create a New MCP Tools Module
 
 Create a new file in the src/client directory with a descriptive name following the pattern: <api_name>_mcp_tools.py
 
 #### 4. Implement the MCP Tools class
 
-Follow any existing tools class under src/clinet to know the template structure for your new class.
+Follow any existing tools class under src/client to know the template structure for your new class.
 
 #### 5. Write API tool Description precisely
 
@@ -81,20 +95,25 @@ async def get_example_data(self, query: str, ctx=None) -> Dict[str, Any]:
 
 #### 6. Update the Main Server File
 
-update src/mcp_server.py to register your new tools:
+Update src/core/server.py to register your new tools:
 
 #### 7. Test Your MCP Tool
 
-build the mcp-instana with
+Build the mcp-instana with:
 
 ```bash
+# For development (editable install)
 uv pip install -e .
+
+# Or install from PyPI
+pip install mcp-instana
 ```
 
-Now open/restart the mcp host like claude desktop/github copilot and then run the query to test your new tool.
+Now open/restart the mcp host like Claude Desktop/GitHub Copilot and then run the query to test your new tool.
 
-To run the MCP server locally for testing:
+To run the MCP server locally:
 
+**Using Development Installation:**
 ```bash
 # Run in Streamable HTTP mode
 uv run src/core/server.py --transport streamable-http --debug
@@ -106,6 +125,18 @@ uv run src/core/server.py --tools app,infra --transport streamable-http
 uv run src/core/server.py --list-tools
 ```
 
+**Using CLI (PyPI Installation):**
+```bash
+# Run in Streamable HTTP mode
+mcp-instana --transport streamable-http --debug
+
+# Run with specific tool categories
+mcp-instana --tools app,infra --transport streamable-http
+
+# List all available tool categories
+mcp-instana --list-tools
+```
+
 #### 8. Add Documentation
 Update the README.md file to include your new tool in the tools table:
 

mcp_instana-0.2.0/Dockerfile

@@ -0,0 +1,60 @@
+# Stage 1: Build stage with minimal runtime dependencies
+FROM python:3.11-slim AS builder
+
+# Install system dependencies needed for building
+RUN apt-get update && apt-get install -y --no-install-recommends \
+    gcc \
+    g++ \
+    && rm -rf /var/lib/apt/lists/*
+
+# Set working directory
+WORKDIR /app
+
+# Copy only the runtime dependency file and source code needed for the build
+COPY pyproject-runtime.toml pyproject.toml
+COPY src ./src
+COPY README.md ./
+
+# Install uv for dependency management
+RUN pip install --no-cache-dir uv
+
+# Install only runtime dependencies using the minimal pyproject-runtime.toml
+RUN uv pip install --no-cache-dir --system .
+
+# Stage 2: Runtime stage
+FROM python:3.11-slim AS runtime
+
+# Set working directory
+WORKDIR /app
+
+# Create a non-root user for security
+RUN groupadd -r mcpuser && useradd -r -g mcpuser mcpuser
+
+# Copy only the Python packages from builder (no source code needed)
+COPY --from=builder /usr/local/lib/python3.11/site-packages /usr/local/lib/python3.11/site-packages
+COPY --from=builder /usr/local/bin /usr/local/bin
+
+# Copy only the source code needed for runtime
+COPY src ./src
+
+# Set ownership to non-root user
+RUN chown -R mcpuser:mcpuser /app
+
+# Switch to non-root user
+USER mcpuser
+
+# Expose the default port (configurable via PORT env var)
+EXPOSE 8080
+
+# Set environment variables (no hardcoded secrets)
+ENV PYTHONPATH=/app
+ENV PYTHONUNBUFFERED=1
+ENV PORT=8080
+
+# Health check using container's internal network
+HEALTHCHECK --interval=30s --timeout=30s --start-period=5s --retries=3 \
+    CMD python -c "import requests; requests.get('http://127.0.0.1:8080/health', timeout=5)" || exit 1
+
+# Run the server
+ENTRYPOINT ["python", "-m", "src.core.server"]
+CMD ["--transport", "streamable-http"]