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

mcp_instana-0.1.1/.github/dco.yml

@@ -0,0 +1,4 @@
+# This enables DCO bot for you, please take a look https://github.com/probot/dco
+# for more details.
+require:
+  members: false

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

@@ -0,0 +1,37 @@
+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
+        
+      - name: Run ruff check
+        run: uv run ruff check .
+        
+      - name: Run tests with verbose output
+        run: uv run test -v
+        
+      - name: Run tests with coverage
+        run: uv run test-coverage

mcp_instana-0.1.1/.gitignore

@@ -0,0 +1,180 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+.DS_Store
+.venv
+
+# Ignore tooling dirs
+.Bob/
+.vscode/

mcp_instana-0.1.1/CONTRIBUTING.md

@@ -0,0 +1,167 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
+
+- [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)
+  - [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)
+  - [6. Update the Main Server File](#6-update-the-main-server-file)
+  - [7. Test Your MCP Tool](#7-test-your-mcp-tool)
+  - [8. Add Documentation](#8-add-documentation)
+  - [9. Code Linting](#9-code-linting)
+  - [Troubleshooting](#troubleshooting)
+  - [Getting Help](#getting-help)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+### Contributing to MCP-Instana
+
+This guide provides step-by-step instructions for building a new MCP (Model Context Protocol) tool for the [Instana API](https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Introduction) within the mcp-instana project.
+
+### Prerequisites
+
+- Python 3.11 or higher
+- Access to Instana API (API token and base URL)
+- Access to Instana python SDK [git+https://github.ibm.com/instana/instana-python-sdk](https://github.ibm.com/instana/instana-python-sdk)
+- Basic understanding of the [Instana API endpoints](https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Introduction)
+- Familiarity with Python async programming
+
+### Steps to Build a New MCP Tool
+
+#### 1. Set Up Your Development Environment
+
+```bash
+# Clone the repository
+git clone https://github.com/instana/mcp-instana.git
+cd mcp-instana
+
+# Set up the environment
+uv sync
+```
+#### 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.
+
+#### 5. Write API tool Description precisely
+
+For each tool, provide a clear description as per the prompt engineering guidelines that helps the LLM understand when to use this tool:
+ 
+
+ ```bash
+
+ @register_as_tool
+async def get_example_data(self, query: str, ctx=None) -> Dict[str, Any]:
+    """
+    Retrieve example data from Instana based on the provided query.
+    
+    This tool is useful when you need to get information about [specific use case].
+    You can filter by [parameters] to narrow down results. Use this when you want
+    to [common user intent], understand [specific information], or analyze [metrics/data].
+    
+    For example, use this tool when asked about '[example query 1]', '[example query 2]',
+    or when someone wants to '[example intent]'.
+    
+    Args:
+        query: Query string to filter results
+        ctx: The MCP context (optional)
+        
+    Returns:
+        Dictionary containing example data or error information
+    """
+ ```
+
+
+#### 6. Update the Main Server File
+
+update src/mcp_server.py to register your new tools:
+
+#### 7. Test Your MCP Tool
+
+build the mcp-instana with
+
+```bash
+uv pip install -e .
+```
+
+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:
+
+```bash
+# Run in Streamable HTTP mode
+uv run src/core/server.py --transport streamable-http --debug
+
+# Run with specific tool categories
+uv run src/core/server.py --tools app,infra --transport streamable-http
+
+# List all available tool categories
+uv run src/core/server.py --list-tools
+```
+
+#### 8. Add Documentation
+Update the README.md file to include your new tool in the tools table:
+
+```bash
+
+| Tool                      | Category          | Description                              |
+|---------------------------|-------------------|------------------------------------------|
+| `[method_name]`           | [API Category]    | [Brief description of what the tool does]|
+```
+
+#### 9. Code Linting
+
+This project uses [Ruff](https://github.com/astral-sh/ruff) for code linting. Ruff is a fast Python linter written in Rust that helps maintain code quality and consistency.
+
+The project ignores several linting rules to accommodate the existing codebase. See the `ignore` list in `pyproject.toml` for the complete list of ignored rules, which includes:
+
+- `E501`: Line too long
+- `SIM117`: Use a single `with` statement with multiple contexts
+- `PLR0912`: Too many branches
+- `E402`: Module level import not at top of file
+- `ARG001`, `ARG002`, `ARG005`: Unused function/method/lambda arguments
+- `PLR2004`: Magic value comparison
+- `PLR0915`: Too many statements
+- `PLR0911`: Too many return statements
+- `B904`: Within an except clause, raise exceptions with raise from
+- And others as needed for the codebase
+
+To run the linter locally:
+
+```bash
+# Run linter to check for issues
+./run_ruff_check.sh
+
+# Run linter and automatically fix issues
+./run_ruff_check.sh --fix
+
+# Run linter and automatically fix issues (including unsafe fixes)
+./run_ruff_check.sh --fix --unsafe-fixes
+```
+
+The project also includes CI integration via GitHub Actions that automatically runs linting checks on all pull requests and pushes to the main branch. The workflow configuration is located in `.github/workflows/lint.yml`.
+
+For pull requests, the CI will:
+1. Check for linting issues
+2. Automatically fix safe linting issues
+3. Commit the fixes back to your branch
+
+Before submitting your code, make sure to run the linter and fix any issues. Many common issues can be automatically fixed using the `--fix` option. The CI pipeline will also verify that your code passes all linting checks.
+
+#### Troubleshooting
+
+If you encounter import errors, check that you're using the correct import paths.
+If API calls fail, verify your API token and base URL.
+Use debug printing to trace the execution flow and identify issues.
+Check the Instana API documentation for any specific requirements or limitations.
+
+#### Getting Help
+
+If you need assistance, please open an issue on the GitHub repository or contact the project maintainers.

mcp_instana-0.1.0/LICENSE → mcp_instana-0.1.1/LICENSE.md

@@ -1,4 +1,4 @@
-                                 Apache License
+Apache License
                            Version 2.0, January 2004
                         http://www.apache.org/licenses/
 
@@ -178,7 +178,7 @@
    APPENDIX: How to apply the Apache License to your work.
 
       To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
+      boilerplate notice, with the fields enclosed by brackets "{}"
       replaced with your own identifying information. (Don't include
       the brackets!)  The text should be enclosed in the appropriate
       comment syntax for the file format. We also recommend that a
@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright 2017 Solo.io, Inc.
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.