asm-mcp 1.0.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,13 @@
1
+ .git
2
+ .github
3
+ .gitlab-ci.yml
4
+ venv
5
+ .venv
6
+ __pycache__
7
+ *.py[cod]
8
+ .ruff_cache
9
+ .env
10
+ opencode.json
11
+ tests
12
+ Dockerfile
13
+ .dockerignore
@@ -0,0 +1,20 @@
1
+ version: 2
2
+ updates:
3
+ # Actions are pinned by commit SHA; Dependabot moves them deliberately, grouped.
4
+ - package-ecosystem: github-actions
5
+ directory: /
6
+ schedule:
7
+ interval: monthly
8
+ groups:
9
+ actions:
10
+ patterns: ["*"]
11
+ commit-message:
12
+ prefix: ci
13
+
14
+ # Version updates are off: Dependabot edits pyproject.toml but cannot
15
+ # regenerate requirements.lock. Security alerts keep working with a limit of 0.
16
+ - package-ecosystem: pip
17
+ directory: /
18
+ schedule:
19
+ interval: monthly
20
+ open-pull-requests-limit: 0
@@ -0,0 +1,76 @@
1
+ name: CI
2
+
3
+ on:
4
+ push:
5
+ branches: [main, master]
6
+ pull_request:
7
+
8
+ permissions:
9
+ contents: read
10
+
11
+ jobs:
12
+ test:
13
+ runs-on: ubuntu-latest
14
+ strategy:
15
+ fail-fast: false
16
+ matrix:
17
+ python-version: ["3.10", "3.11", "3.12", "3.13"]
18
+ steps:
19
+ - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
20
+
21
+ - uses: actions/setup-python@6d4fd22b20465ccc0f7354476588e8df7c9ca0e0 # v7.1.0
22
+ with:
23
+ python-version: ${{ matrix.python-version }}
24
+
25
+ # Hash-pinned: the server holds a live ASM API token, so a substituted
26
+ # dependency is a credential compromise, not just a broken build.
27
+ - name: Install locked dependencies
28
+ run: pip install --require-hashes -r requirements.lock
29
+
30
+ - name: Install the package without touching the locked tree
31
+ run: pip install --no-deps -e .
32
+
33
+ - name: Run tests
34
+ run: python -m unittest discover -s tests -v
35
+
36
+ - name: Check the lock satisfies what the package declares
37
+ run: pip check
38
+
39
+ lint:
40
+ runs-on: ubuntu-latest
41
+ steps:
42
+ - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
43
+
44
+ - uses: actions/setup-python@6d4fd22b20465ccc0f7354476588e8df7c9ca0e0 # v7.1.0
45
+ with:
46
+ python-version: "3.12"
47
+
48
+ # --group needs pip 25.1 or newer.
49
+ - run: |
50
+ python -m pip install --upgrade pip
51
+ pip install --group dev
52
+
53
+ - run: ruff check .
54
+
55
+ lock:
56
+ runs-on: ubuntu-latest
57
+ steps:
58
+ - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
59
+
60
+ - uses: astral-sh/setup-uv@68559e99cc807c1eb7e9238fd43a15bba460eec2 # v10.3.3
61
+ with:
62
+ version: "0.12.10"
63
+
64
+ # Fails if pyproject.toml and requirements.lock have drifted apart. The lock
65
+ # is copied first because uv seeds the resolution from an existing output
66
+ # file: this asks "does the lock still match pyproject", not "is it the
67
+ # newest resolve".
68
+ - name: Verify the lock is current
69
+ run: |
70
+ mkdir -p /tmp/lockcheck
71
+ cp requirements.lock /tmp/lockcheck/requirements.lock
72
+ uv pip compile pyproject.toml --universal --python-version 3.10 \
73
+ --generate-hashes -o /tmp/lockcheck/requirements.lock --quiet
74
+ diff -u \
75
+ <(grep -v '^# uv pip compile' requirements.lock) \
76
+ <(grep -v '^# uv pip compile' /tmp/lockcheck/requirements.lock)
@@ -0,0 +1,49 @@
1
+ name: Publish
2
+
3
+ on:
4
+ release:
5
+ types: [published]
6
+
7
+ permissions:
8
+ contents: read
9
+
10
+ jobs:
11
+ # A release whose tag does not match __version__ would upload nothing new to
12
+ # PyPI (skip-existing) and leave the release pointing at the wrong code.
13
+ version:
14
+ runs-on: ubuntu-latest
15
+ steps:
16
+ - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
17
+ - name: Check the release tag matches the package version
18
+ run: |
19
+ version=$(sed -n 's/^__version__ = "\(.*\)"$/\1/p' src/asm_mcp/__init__.py)
20
+ if [ "${GITHUB_REF_NAME#v}" != "$version" ]; then
21
+ echo "::error::release tag $GITHUB_REF_NAME does not match __version__ $version"
22
+ exit 1
23
+ fi
24
+
25
+ publish:
26
+ needs: version
27
+ runs-on: ubuntu-latest
28
+ environment: pypi
29
+ permissions:
30
+ # A job-level permissions block replaces the workflow-level one, so
31
+ # checkout's contents: read has to be repeated here.
32
+ contents: read
33
+ # PyPI trusted publishing: no long-lived API token in repository secrets.
34
+ id-token: write
35
+ steps:
36
+ - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
37
+
38
+ - uses: actions/setup-python@6d4fd22b20465ccc0f7354476588e8df7c9ca0e0 # v7.1.0
39
+ with:
40
+ python-version: "3.12"
41
+
42
+ - run: pip install build==1.3.0
43
+
44
+ - run: python -m build
45
+
46
+ - uses: pypa/gh-action-pypi-publish@7245906fb61fa33a13554f9d5fb856fe61758086 # v1.14.3
47
+ with:
48
+ # a version published by hand earlier must not fail the release
49
+ skip-existing: true
@@ -0,0 +1,10 @@
1
+ venv/
2
+ .venv/
3
+ /dist/
4
+ *.egg-info/
5
+ __pycache__/
6
+ *.py[cod]
7
+ .ruff_cache/
8
+ .env
9
+ opencode.json
10
+ .DS_Store
@@ -0,0 +1,89 @@
1
+ # Участие в разработке
2
+
3
+ ## Окружение
4
+
5
+ Нужен Python 3.10+.
6
+
7
+ ```sh
8
+ python3 -m venv venv
9
+ ./venv/bin/pip install --require-hashes -r requirements.lock
10
+ ./venv/bin/pip install --no-deps -e .
11
+ ./venv/bin/pip install --group dev
12
+ ```
13
+
14
+ Зависимости ставятся из лока с проверкой хешей. Сервер держит живой API-токен,
15
+ поэтому подменённая зависимость здесь означает утечку доступа, а не просто
16
+ сломанную сборку. Для `--group` нужен pip 25.1 или новее.
17
+
18
+ ## Тесты и линт
19
+
20
+ ```sh
21
+ ./venv/bin/python -m unittest discover -s tests -v
22
+ ./venv/bin/ruff check .
23
+ ```
24
+
25
+ Сеть тестам не нужна. HTTP-клиент подменяется через `httpx.MockTransport`.
26
+ `tests/support.py` содержит `FakeASM` — эмулятор `/assets/updated` и
27
+ `/issues/updated` с особенностями настоящего API:
28
+
29
+ - утечка фильтра статуса;
30
+ - пустые страницы при маленьком `count`;
31
+ - таймауты на больших страницах;
32
+ - ответ активов в виде массива.
33
+
34
+ Handshake по stdio проверяется на установленной команде `asm-mcp`.
35
+
36
+ ## Зависимости
37
+
38
+ Версии задаются в `pyproject.toml`, а `requirements.lock` генерируется из них.
39
+ После правки зависимостей пересоберите лок, иначе CI это заметит:
40
+
41
+ ```sh
42
+ uv pip compile pyproject.toml --universal --python-version 3.10 --generate-hashes -o requirements.lock
43
+ ```
44
+
45
+ ## Проверить сервер вручную
46
+
47
+ ```sh
48
+ printf '%s\n' \
49
+ '{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2025-06-18","capabilities":{},"clientInfo":{"name":"probe","version":"0"}}}' \
50
+ '{"jsonrpc":"2.0","method":"notifications/initialized"}' \
51
+ '{"jsonrpc":"2.0","id":2,"method":"tools/list"}' \
52
+ | ASM_BASE_URL=https://asm.example.com ASM_API_TOKEN=<token> asm-mcp
53
+ ```
54
+
55
+ ## Структура кода
56
+
57
+ | Модуль | Содержимое |
58
+ | --- | --- |
59
+ | `settings.py` | `Settings`: переменные окружения, читаются и проверяются один раз при запуске |
60
+ | `catalog.py` | Справочник: типы и статусы, severity, поля, особенности API, список read-only маршрутов `ROUTES` |
61
+ | `params.py` | Проверки аргументов: id, курсор, фильтры, маршруты `asm_request` |
62
+ | `arguments.py` | Модели аргументов тулов на pydantic. Из одной модели получаются и проверка, и `inputSchema` |
63
+ | `client.py` | `ASMClient`: пул соединений, Bearer, троттлинг, ретраи, подсказки по статусам, лимиты ответа |
64
+ | `paging.py` | Обход по `seqUpdate`, адаптивный размер страницы, компактный вид записей |
65
+ | `summary.py` | Счётчики сводок и фоновые задачи в памяти |
66
+ | `server.py` | Тулы (`@tool`), состояние сервера (`AppState`), точка входа `cli` |
67
+
68
+ Глобального состояния нет. Настройки, клиент, троттлер и фоновые задачи
69
+ создаются при старте сервера и живут, пока он работает.
70
+
71
+ Новый тул добавляется в `server.py`: это функция-обработчик с декоратором
72
+ `@tool(имя, модель, описание)`. Модель аргументов описывается классом в
73
+ `arguments.py`. Новый read-only эндпоинт подключается записью `Route(...)` в
74
+ `catalog.ROUTES`. Эндпоинты, которые меняют данные, туда не добавляются.
75
+
76
+ ## Документация
77
+
78
+ `README.md` и `README.en.md` должны совпадать по содержанию, раздел в раздел.
79
+ Правьте оба файла.
80
+
81
+ ## Релиз
82
+
83
+ Версия задаётся в `src/asm_mcp/__init__.py` и оттуда попадает в метаданные
84
+ пакета, версию MCP-сервера и User-Agent. Публикация на PyPI запускается
85
+ публикацией GitHub Release (`.github/workflows/publish.yml`, trusted publishing,
86
+ без токенов в секретах). Тег релиза (`vX.Y.Z`) должен совпадать с версией
87
+ пакета, иначе публикация остановится.
88
+
89
+ Ссылки в README абсолютные: PyPI не резолвит относительные пути.
@@ -0,0 +1,29 @@
1
+ # Build the wheel separately so the runtime image carries no build toolchain.
2
+ FROM python:3.12-slim AS build
3
+
4
+ WORKDIR /build
5
+ RUN pip install --no-cache-dir build==1.3.0
6
+
7
+ COPY pyproject.toml README.md LICENSE NOTICE ./
8
+ COPY src ./src
9
+ RUN python -m build --wheel --outdir /dist
10
+
11
+
12
+ FROM python:3.12-slim
13
+
14
+ # Dependencies come from the hash-pinned lock, the package itself without
15
+ # resolving anything further, so the image matches what CI tested.
16
+ COPY requirements.lock /tmp/requirements.lock
17
+ RUN pip install --no-cache-dir --require-hashes -r /tmp/requirements.lock \
18
+ && rm /tmp/requirements.lock
19
+
20
+ COPY --from=build /dist/*.whl /tmp/
21
+ RUN pip install --no-cache-dir --no-deps /tmp/*.whl && rm /tmp/*.whl
22
+
23
+ # The process holds a live ASM API token; it has no reason to run as root.
24
+ RUN useradd --create-home --uid 10001 asm
25
+ USER asm
26
+
27
+ # stdio transport: the MCP client talks to this process over stdin/stdout,
28
+ # so the container must be run with -i and must print nothing else to stdout.
29
+ ENTRYPOINT ["asm-mcp"]
asm_mcp-1.0.0/LICENSE ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
asm_mcp-1.0.0/NOTICE ADDED
@@ -0,0 +1,5 @@
1
+ F6 ASM MCP Server
2
+ Copyright 2026 F6 JSC
3
+
4
+ This product includes software developed at F6 JSC
5
+ (https://f6.security).