diff --git a/.github/instructions/python-docstring.instructions.md b/.github/instructions/python-docstring.instructions.md new file mode 100644 index 0000000..fce61b7 --- /dev/null +++ b/.github/instructions/python-docstring.instructions.md @@ -0,0 +1,15 @@ +--- +applyTo: '**/*.py' +--- + +Follow these guidelines for writing clear and consistent Python docstrings: + +- Always use triple quotes (""") for docstrings +- Follow Google-style docstring format +- Include these sections when applicable: + - Brief one-line description + - Detailed description (if needed) + - Args/Parameters without typing + - Returns + - Raises + - Examples diff --git a/.github/instructions/python.instructions.md b/.github/instructions/python.instructions.md new file mode 100644 index 0000000..af729b0 --- /dev/null +++ b/.github/instructions/python.instructions.md @@ -0,0 +1,25 @@ +--- +applyTo: '**/*.py' +--- + +# Python Coding Standards + +- Use Python 3.10+ syntax and features. +- Follow PEP 8 for code style and formatting. +- Use type annotations for all function signatures and variables. +- Prefer f-strings for string formatting. +- Avoid wildcard imports; import only what you need. +- Organize imports using `ruff` or `isort` conventions: standard library, third-party, local. +- Write small, single-responsibility functions and classes. +- Avoid global variables; prefer dependency injection or class attributes. +- Use context managers (`with` statements) for resource management. +- Prefer list comprehensions and generator expressions over manual loops when appropriate. +- Use built-in exceptions or define custom exceptions for error handling. +- Document all public modules, classes, and functions. + +## Formatting and Linting + +The project is using Use ruff and mypy for type checking and validations. + +you can format all python files by running `uv run invoke format` +and you can validate that all files are formatted correctly by running `uv run invoke lint` diff --git a/.github/instructions/tooling.instructions.md b/.github/instructions/tooling.instructions.md new file mode 100644 index 0000000..0816923 --- /dev/null +++ b/.github/instructions/tooling.instructions.md @@ -0,0 +1,11 @@ +--- +applyTo: '*' +--- + +# Tooling rules + +- Prefer Github Actions for automated validation when user commit to the repository +- Don't use Git precommit +- Use ruff and mypy to validate and lint python files +- Use yamllint to validate yaml files +- Use uv to manage the python project and its dependencies \ No newline at end of file diff --git a/.github/workflows/sync-docs.yml b/.github/workflows/sync-docs.yml index 4e34694..84a28f1 100644 --- a/.github/workflows/sync-docs.yml +++ b/.github/workflows/sync-docs.yml @@ -1,39 +1,39 @@ ---- +# --- # yamllint disable rule:truthy -name: Sync Folders +# name: Sync Folders -on: - push: - branches: - - main - paths: - - 'docs/docs/**' - - 'docs/sidebars.ts' +# on: +# push: +# branches: +# - main +# paths: +# - 'docs/docs/**' +# - 'docs/sidebars.ts' -jobs: - sync: - runs-on: ubuntu-latest - steps: - - name: Checkout source repository - uses: actions/checkout@v4 - with: - path: source-repo +# jobs: +# sync: +# runs-on: ubuntu-latest +# steps: +# - name: Checkout source repository +# uses: actions/checkout@v4 +# with: +# path: source-repo - - name: Checkout target repository - uses: actions/checkout@v4 - with: - repository: opsmill/infrahub-docs - token: ${{ secrets.PAT_TOKEN }} - path: target-repo +# - name: Checkout target repository +# uses: actions/checkout@v4 +# with: +# repository: opsmill/infrahub-docs +# token: ${{ secrets.PAT_TOKEN }} +# path: target-repo - - name: Sync folders - run: | - rm -rf target-repo/docs/docs-mcp/* - rm -f target-repo/docs/sidebars-mcp.ts - cp -r source-repo/docs/docs/* target-repo/docs/docs-mcp/ - cp source-repo/docs/sidebars.ts target-repo/docs/sidebars-mcp.ts - cd target-repo - git config user.name github-actions - git config user.email github-actions@github.com - git add . - if ! (git diff --quiet && git diff --staged --quiet); then git commit -m "Sync docs from mcp repo" && git push; fi +# - name: Sync folders +# run: | +# rm -rf target-repo/docs/docs-mcp/* +# rm -f target-repo/docs/sidebars-mcp.ts +# cp -r source-repo/docs/docs/* target-repo/docs/docs-mcp/ +# cp source-repo/docs/sidebars.ts target-repo/docs/sidebars-mcp.ts +# cd target-repo +# git config user.name github-actions +# git config user.email github-actions@github.com +# git add . +# if ! (git diff --quiet && git diff --staged --quiet); then git commit -m "Sync docs from mcp repo" && git push; fi diff --git a/.yamllint.yml b/.yamllint.yml deleted file mode 100644 index 6a47615..0000000 --- a/.yamllint.yml +++ /dev/null @@ -1,25 +0,0 @@ ---- -extends: default - -ignore: | - /.git - /.venv - /examples - /repositories - /frontend/**/playwright-report - **/node_modules - # https://github.com/sbaudoin/yamllint/issues/16 - /helm/templates - /python_sdk - -rules: - new-lines: disable - comments-indentation: disable - comments: - # Changed this to stop a mess between linters from Prettier (vscode) to yamllint - # See https://github.com/prettier/prettier/pull/10926 or https://github.com/redhat-developer/vscode-yaml/issues/433 - min-spaces-from-content: 1 - line-length: - max: 120 - allow-non-breakable-words: true - allow-non-breakable-inline-mappings: false diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..06154b9 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + 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 "[]" + 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 + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2024 OpsMill SAS + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/README.md b/README.md index 8e2884c..758aca2 100644 --- a/README.md +++ b/README.md @@ -2,32 +2,16 @@ MCP server to interact with Infrahub -## Requirements - -- Python 3.13+ -- fastmcp -- infrahub_sdk - ## Installation 1. **Clone the repo** - ```bash - git clone https://github.com/opsmill/infrahub-mcp-server.git - cd infrahub-mcp-server - ``` - -2. **Install dependencies** - - ```bash - uv sync - ``` - -3. **Run the server** - - ```bash - uv run fastmcp run src/infrahub_mcp_server/server.py:mcp - ``` +```bash +git clone https://github.com/opsmill/infrahub-mcp-server.git +cd infrahub-mcp-server +uv sync +uv run fastmcp run src/infrahub_mcp_server/server.py:mcp +``` ## Configuration @@ -40,107 +24,3 @@ Set the following environment variables as needed: | `MCP_HOST` | Host for the web server | `0.0.0.0` | | `MCP_PORT` | Port for the web server | `8001` | -## Usage - -### HTTP API mode - -```bash -poetry run python server.py --web -``` - -Send a POST request to the root endpoint (/): - -```bash -curl -X POST http://localhost:8001/ \\ - -H "Content-Type: application/json" \\ - -d '{ - "tool": "infrahub_get_nodes", - "params": { - "kind": "Tag", - "filters": { "any": "blue" }, - "partial_match": false - } - }' -``` - -### CLI / stdin-stdout mode - -```bash -uv run fastmcp run src/infrahub_mcp_server/server.py:mcp -``` - -Then send JSON-RPC requests to stdin: - -```bash -{"jsonrpc":"2.0","method":"tools/discover","params":{}} -{"jsonrpc":"2.0","method":"tools/call","params":{"name": "infrahub_get_nodes","arguments": {"kind":"Router","filters": {"location":"eu-west"}}}} -``` - -Process one-shot request with --oneshot: - -```bash -echo '{"method":"tools/discover"}' | poetry run python server.py --oneshot -``` - -## MCP Methods - -### infrahub_get_nodes -Retrieve nodes of a given kind. - -Params: - -- kind (string, required): node kind (e.g. "Router") -- branch (string): branch name -- filters (object): key/value filters -- simple keys → __value -- list values → __values -- use "any" to search across all attributes -- partial_match (boolean): true for substring matches -- infrahub_url (string): override via param -- infrahub_api_token (string): override via param - -Response: - -```json -{ - "success": true, - "count": 5, - "nodes": [ { ... }, ... ] -} -``` - -### infrahub_get_schema - -Retrieve schema details. - -Params: - -- kind (string): kind name; omit to fetch all schemas -- branch (string) -- exclude_profiles (boolean) -- exclude_templates (boolean) -- infrahub_url (string) -- infrahub_api_token (string) - -Response (single kind): - -```json -{ - "success": true, - "kind": "Tag", - "namespace": "...", - "name": "...", - "attributes": [ { "name": "...", "type": "...", "description": "..." }, ... ], - "relationships": [ { "name": "...", "rel_kind": "...", "cardinality": "...", "description": "..." }, ... ] -} -``` - -Response (all schemas): - -```json -{ - "success": true, - "count": 12, - "schemas": [ { ... }, ... ] -} -```