mcpgawk 0.1.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.
- mcpgawk-0.1.0/.github/workflows/ci.yml +38 -0
- mcpgawk-0.1.0/.gitignore +11 -0
- mcpgawk-0.1.0/BRAND.md +48 -0
- mcpgawk-0.1.0/CHANGELOG.md +21 -0
- mcpgawk-0.1.0/CONTRIBUTING.md +30 -0
- mcpgawk-0.1.0/LICENSE +201 -0
- mcpgawk-0.1.0/NOTICE +10 -0
- mcpgawk-0.1.0/PKG-INFO +130 -0
- mcpgawk-0.1.0/README.md +101 -0
- mcpgawk-0.1.0/SECURITY.md +23 -0
- mcpgawk-0.1.0/THREAT-MODEL.md +44 -0
- mcpgawk-0.1.0/assets/brand/demo.gif +0 -0
- mcpgawk-0.1.0/assets/brand/favicon.svg +7 -0
- mcpgawk-0.1.0/assets/brand/identity-board.html +39 -0
- mcpgawk-0.1.0/assets/brand/nativerse-mark.svg +6 -0
- mcpgawk-0.1.0/assets/brand/social-preview.png +0 -0
- mcpgawk-0.1.0/assets/brand/social-preview.svg +15 -0
- mcpgawk-0.1.0/assets/brand/wordmark-dark.png +0 -0
- mcpgawk-0.1.0/assets/brand/wordmark-dark.svg +8 -0
- mcpgawk-0.1.0/assets/brand/wordmark-light.png +0 -0
- mcpgawk-0.1.0/assets/brand/wordmark-light.svg +8 -0
- mcpgawk-0.1.0/docs/assets/brand/favicon.svg +7 -0
- mcpgawk-0.1.0/docs/assets/brand/nativerse-mark.svg +6 -0
- mcpgawk-0.1.0/docs/assets/brand/social-preview.png +0 -0
- mcpgawk-0.1.0/docs/assets/brand/social-preview.svg +15 -0
- mcpgawk-0.1.0/docs/index.html +112 -0
- mcpgawk-0.1.0/examples/mcp.json +32 -0
- mcpgawk-0.1.0/pyproject.toml +46 -0
- mcpgawk-0.1.0/src/mcpgawk/__init__.py +16 -0
- mcpgawk-0.1.0/src/mcpgawk/__main__.py +6 -0
- mcpgawk-0.1.0/src/mcpgawk/cli.py +121 -0
- mcpgawk-0.1.0/src/mcpgawk/drift.py +84 -0
- mcpgawk-0.1.0/src/mcpgawk/history.py +49 -0
- mcpgawk-0.1.0/src/mcpgawk/label.py +89 -0
- mcpgawk-0.1.0/src/mcpgawk/measure.py +103 -0
- mcpgawk-0.1.0/src/mcpgawk/probe.py +129 -0
- mcpgawk-0.1.0/src/mcpgawk/servercard.py +69 -0
- mcpgawk-0.1.0/src/mcpgawk/signals.py +129 -0
- mcpgawk-0.1.0/tests/test_drift.py +36 -0
- mcpgawk-0.1.0/tests/test_measure.py +56 -0
- mcpgawk-0.1.0/tests/test_no_egress.py +91 -0
- mcpgawk-0.1.0/tests/test_servercard.py +87 -0
- mcpgawk-0.1.0/tests/test_signals.py +82 -0
- mcpgawk-0.1.0/uv.lock +1355 -0
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
name: CI
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches: [main]
|
|
6
|
+
pull_request:
|
|
7
|
+
|
|
8
|
+
jobs:
|
|
9
|
+
test:
|
|
10
|
+
runs-on: ubuntu-latest
|
|
11
|
+
strategy:
|
|
12
|
+
fail-fast: false
|
|
13
|
+
matrix:
|
|
14
|
+
python-version: ["3.10", "3.11", "3.12", "3.13"]
|
|
15
|
+
steps:
|
|
16
|
+
- uses: actions/checkout@v4
|
|
17
|
+
- uses: actions/setup-python@v5
|
|
18
|
+
with:
|
|
19
|
+
python-version: ${{ matrix.python-version }}
|
|
20
|
+
- run: python -m pip install --upgrade pip
|
|
21
|
+
- run: pip install -e ".[dev]"
|
|
22
|
+
- name: Run tests (incl. the structural no-egress invariant)
|
|
23
|
+
run: pytest -q
|
|
24
|
+
|
|
25
|
+
build:
|
|
26
|
+
runs-on: ubuntu-latest
|
|
27
|
+
steps:
|
|
28
|
+
- uses: actions/checkout@v4
|
|
29
|
+
- uses: actions/setup-python@v5
|
|
30
|
+
with:
|
|
31
|
+
python-version: "3.12"
|
|
32
|
+
- run: python -m pip install --upgrade pip build
|
|
33
|
+
- run: python -m build
|
|
34
|
+
- name: Install the built wheel in a clean env and smoke-test the CLI
|
|
35
|
+
run: |
|
|
36
|
+
python -m venv /tmp/smoke
|
|
37
|
+
/tmp/smoke/bin/pip install dist/*.whl
|
|
38
|
+
/tmp/smoke/bin/mcpgawk --help
|
mcpgawk-0.1.0/.gitignore
ADDED
mcpgawk-0.1.0/BRAND.md
ADDED
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# mcpgawk — brand spec (Nativerse / gawk.dev family)
|
|
2
|
+
|
|
3
|
+
mcpgawk is a **gawk.dev-family** open tool under **Nativerse Ventures**. Its identity inherits the Nativerse
|
|
4
|
+
system — it does **not** invent its own. (The legacy "gawk black/teal" is superseded by the royal-blue convergence.)
|
|
5
|
+
|
|
6
|
+
## Palette (locked to Nativerse tokens — `nativerse-site/styles.css`)
|
|
7
|
+
| Token | Hex | Use |
|
|
8
|
+
|---|---|---|
|
|
9
|
+
| Surface (dark) | `#16160F` | product / social / OG background — the family is dark on these surfaces |
|
|
10
|
+
| Accent — royal blue | `#2A33C2` | the **only** brand accent (`--blue`) |
|
|
11
|
+
| Blue strong | `#1F2799` | pressed / deeper accent (`--blue-strong`) |
|
|
12
|
+
| Accent on dark | `#7B83F0` | same hue lightened for legibility on `#16160F` |
|
|
13
|
+
| Status — live/open | `#36C28B` | semantic green only (the `●` status dot; "clean / scanned / open") |
|
|
14
|
+
| Ink | `#16160F` on light; near-white `#ECEBE3` on dark | text |
|
|
15
|
+
| Rules | hairline grey | dividers only |
|
|
16
|
+
|
|
17
|
+
One accent. Semantic green for status only. Hairline rules. Generous whitespace. Editorial restraint.
|
|
18
|
+
|
|
19
|
+
## Type (the family stack — Fontshare)
|
|
20
|
+
- **Wordmark & display:** **Sentient** (`--font-display`, serif) — the lowercase `mcpgawk` wordmark is set in
|
|
21
|
+
Sentient, exactly like the parent `nativerse` wordmark, so it sits flush in the family. **Not monospace.**
|
|
22
|
+
(Raw mono for the name read out of place next to the Sentient-led family — corrected.)
|
|
23
|
+
- **Text/UI:** **Supreme** (`--font-text`, geometric sans).
|
|
24
|
+
- **Data/proof/kickers:** **Tabular** (`--font-mono`) — this is where mono lives: the scan output, numbers,
|
|
25
|
+
labels. Reserved for data, never the name.
|
|
26
|
+
|
|
27
|
+
## Mark
|
|
28
|
+
- **Primary mark = the real Nativerse interlocking-N hex-shield** (`assets/brand/nativerse-mark.svg`, single
|
|
29
|
+
fill `#2A33C2`). Per family rule: **recoloured white on dark surfaces**, `#2A33C2` on light.
|
|
30
|
+
- **Lockup** = mark + `mcpgawk` Sentient wordmark (horizontal). Wordmark-led (Linear/Stripe/Vercel discipline).
|
|
31
|
+
- **Favicon / avatar** = the white mark on a `#2A33C2` tile (the documented family avatar).
|
|
32
|
+
- The CLI's `●` status dot (green `#36C28B`) stays as an in-product motif in data contexts — not the logo.
|
|
33
|
+
|
|
34
|
+
## Lockups needed
|
|
35
|
+
1. Wordmark `● mcpgawk` — light-on-dark (primary, product surfaces) + dark-on-white (docs).
|
|
36
|
+
2. Favicon — the `●` dot.
|
|
37
|
+
3. GitHub social preview (1280×640) — dark surface, `● mcpgawk`, one-line promise, hairline rule.
|
|
38
|
+
|
|
39
|
+
## Production note (before push)
|
|
40
|
+
The `wordmark-*.svg` and `social-preview.svg` reference **Sentient**, which loads on the site but **not** in
|
|
41
|
+
GitHub's README `<img>` sandbox or on PyPI (they'll show the serif fallback). For pixel-true assets, render
|
|
42
|
+
them through the family pipeline — `~/nativerse-site/brand/logo/render-lockups.sh` bakes Sentient in — and
|
|
43
|
+
commit the resulting **PNGs** (plus a `.png` social preview, which GitHub's social-preview upload requires).
|
|
44
|
+
Until then the SVGs are correct in direction (real mark + serif wordmark), just not the exact face on GitHub.
|
|
45
|
+
|
|
46
|
+
## Voice
|
|
47
|
+
Precise, honest, terminal-native, no hype. "gawk at it before you trust it." Trust through reproducibility,
|
|
48
|
+
never adjectives.
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to mcpgawk. Format: [Keep a Changelog](https://keepachangelog.com/); versioning: [SemVer](https://semver.org/).
|
|
4
|
+
|
|
5
|
+
## [0.1.0] — unreleased
|
|
6
|
+
|
|
7
|
+
Initial release. Local-first MCP measurement.
|
|
8
|
+
|
|
9
|
+
### Added
|
|
10
|
+
- `mcpgawk scan` over stdio, streamable-HTTP, and SSE via the official `mcp` SDK (protocol-version negotiated).
|
|
11
|
+
- Cost **index** (named tokenizer) + **EXACT** capability facts (write / exfil-capable / annotations) + **integrity pin**.
|
|
12
|
+
- **Bounded** heuristic signals (0-FP on the tested corpus, never verdicts): injection-shaped descriptions
|
|
13
|
+
(tools and prompts), cross-server name shadowing, Server-Card under-declaration.
|
|
14
|
+
- `--track` rug-pull / drift monitor with a local history store.
|
|
15
|
+
- Server Card reader (`/.well-known/mcp/server-card.json`) — reads the card when present, checks
|
|
16
|
+
declared-vs-measured, falls back to live-connect. Fetched with no auth and no redirect-following.
|
|
17
|
+
- Label output as a Server-Card extension (`x-mcpgawk`); `--json` for machine consumption.
|
|
18
|
+
|
|
19
|
+
### Security
|
|
20
|
+
- Measurement layers import no network library — cannot egress by construction (enforced by test).
|
|
21
|
+
- Per-server timeout so a hung server degrades to one error row.
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# Contributing to mcpgawk
|
|
2
|
+
|
|
3
|
+
Thanks for helping. mcpgawk is small on purpose. Two rules are non-negotiable — a PR that breaks
|
|
4
|
+
either will not be merged.
|
|
5
|
+
|
|
6
|
+
## The two invariants
|
|
7
|
+
|
|
8
|
+
1. **No inventory egress.** The measurement layers (`measure`, `label`, `signals`, `drift`, `history`)
|
|
9
|
+
must never import a network library or send anything anywhere. Network lives only in `probe.py` (the
|
|
10
|
+
protocol client talking to the scanned server) and `servercard.py` (public, unauthenticated card
|
|
11
|
+
fetch — no auth headers, no redirect-following). A test enforces this; don't weaken it.
|
|
12
|
+
|
|
13
|
+
2. **Zero false positives, or the signal is cut.** Any new BOUNDED signal must be *precise* (it fires on
|
|
14
|
+
language aimed at the model, never on legitimate capability keywords) and must score **0 false
|
|
15
|
+
positives** on the test corpus before it ships. A capability keyword (`url`, `delete`, `base64`) is a
|
|
16
|
+
*fact* (`measure.py`), never a signal. A signal is a pointer for a human, never a verdict.
|
|
17
|
+
|
|
18
|
+
## Also
|
|
19
|
+
- Keep the EXACT / INDEX / BOUNDED tiers separate — never let a heuristic contaminate a fact.
|
|
20
|
+
- Cost is a **named tokenizer index**, not an absolute count — keep it labelled honestly.
|
|
21
|
+
- Add a test with every change. Run: `uv run --extra dev --with mcp --with tiktoken --with httpx python -m pytest -q`.
|
|
22
|
+
- No telemetry, no account, no "phone home" — ever. That is the whole point of the tool.
|
|
23
|
+
|
|
24
|
+
## Dev setup
|
|
25
|
+
```bash
|
|
26
|
+
git clone <repo> && cd mcpgawk
|
|
27
|
+
uv run --with mcp --with tiktoken --with httpx python -m mcpgawk scan examples/mcp.json
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
By contributing you agree your contribution is licensed under Apache-2.0.
|
mcpgawk-0.1.0/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2025 Invariant Labs AG
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
mcpgawk-0.1.0/NOTICE
ADDED
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
The reference/ directory contains unmodified third-party source cloned for study,
|
|
2
|
+
each under the Apache License 2.0, © Invariant Labs / Snyk:
|
|
3
|
+
|
|
4
|
+
- invariantlabs-ai/invariant (reference/invariant-analyzer)
|
|
5
|
+
- invariantlabs-ai/invariant-gateway (reference/invariant-gateway)
|
|
6
|
+
- invariantlabs-ai/mcp-scan (reference/mcp-scan-hist, reference/recovered-local-engine)
|
|
7
|
+
|
|
8
|
+
These retain their upstream LICENSE files and git history. They are NOT our code and are
|
|
9
|
+
not vendored into this project's git history. Any code we derive from them will carry the
|
|
10
|
+
required Apache-2.0 attribution.
|
mcpgawk-0.1.0/PKG-INFO
ADDED
|
@@ -0,0 +1,130 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: mcpgawk
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Local-first MCP measurement — gawk at an MCP server before you trust it. No inventory ever leaves your machine.
|
|
5
|
+
Project-URL: Homepage, https://mcp.gawk.dev
|
|
6
|
+
Project-URL: Documentation, https://mcp.gawk.dev
|
|
7
|
+
Project-URL: Repository, https://github.com/gawk-dev/mcpgawk
|
|
8
|
+
Project-URL: Issues, https://github.com/gawk-dev/mcpgawk/issues
|
|
9
|
+
Author: Neelagiri
|
|
10
|
+
License-Expression: Apache-2.0
|
|
11
|
+
License-File: LICENSE
|
|
12
|
+
License-File: NOTICE
|
|
13
|
+
Keywords: agents,cli,llm,local-first,mcp,model-context-protocol,security,tokenizer,tokens
|
|
14
|
+
Classifier: Development Status :: 4 - Beta
|
|
15
|
+
Classifier: Environment :: Console
|
|
16
|
+
Classifier: Intended Audience :: Developers
|
|
17
|
+
Classifier: License :: OSI Approved :: Apache Software License
|
|
18
|
+
Classifier: Programming Language :: Python :: 3
|
|
19
|
+
Classifier: Topic :: Security
|
|
20
|
+
Classifier: Topic :: Software Development :: Libraries
|
|
21
|
+
Requires-Python: >=3.10
|
|
22
|
+
Requires-Dist: httpx>=0.27
|
|
23
|
+
Requires-Dist: mcp<2,>=1.28
|
|
24
|
+
Requires-Dist: tiktoken>=0.7
|
|
25
|
+
Provides-Extra: dev
|
|
26
|
+
Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
|
|
27
|
+
Requires-Dist: pytest>=8; extra == 'dev'
|
|
28
|
+
Description-Content-Type: text/markdown
|
|
29
|
+
|
|
30
|
+
<p align="center">
|
|
31
|
+
<picture>
|
|
32
|
+
<source media="(prefers-color-scheme: dark)" srcset="assets/brand/wordmark-dark.png">
|
|
33
|
+
<img alt="mcpgawk by nativerse" src="assets/brand/wordmark-light.png" width="320">
|
|
34
|
+
</picture>
|
|
35
|
+
</p>
|
|
36
|
+
<p align="center"><em>gawk at it before you trust it.</em></p>
|
|
37
|
+
|
|
38
|
+
# mcpgawk
|
|
39
|
+
|
|
40
|
+
[](https://pypi.org/project/mcpgawk/)
|
|
41
|
+
[](https://pypi.org/project/mcpgawk/)
|
|
42
|
+
[](LICENSE)
|
|
43
|
+
[](https://github.com/gawk-dev/mcpgawk/actions/workflows/ci.yml)
|
|
44
|
+
[](#guarantees)
|
|
45
|
+
|
|
46
|
+
**gawk at an MCP server before you trust it.** A single, local-first command that connects to any
|
|
47
|
+
[Model Context Protocol](https://modelcontextprotocol.io) server and measures what it will cost and
|
|
48
|
+
expose — **without the server's inventory ever leaving your machine.**
|
|
49
|
+
|
|
50
|
+
<p align="center">
|
|
51
|
+
<img src="assets/brand/demo.gif" alt="mcpgawk scanning an MCP server — tools, token cost, and capability flags, locally" width="760">
|
|
52
|
+
</p>
|
|
53
|
+
<p align="center"><sub>Real output. Reproducible on your machine — no account, nothing uploaded.</sub></p>
|
|
54
|
+
|
|
55
|
+
## Why
|
|
56
|
+
|
|
57
|
+
Every MCP server you connect dumps *all* its tool definitions into your model's context at connect
|
|
58
|
+
time — whether you use one tool or none. That's a hidden **token tax** and an unvetted **trust
|
|
59
|
+
surface**. mcpgawk measures both, **locally**, and never phones home about what it saw.
|
|
60
|
+
|
|
61
|
+
## How it's different
|
|
62
|
+
|
|
63
|
+
- **vs. cloud scanners** (e.g. Snyk/Invariant `mcp-scan`) — they upload your inventory to a server and
|
|
64
|
+
gate the verdict. mcpgawk runs entirely on your machine; nothing is uploaded, ever.
|
|
65
|
+
- **vs. lazy-load gateways** — they cut tokens but tell you nothing about the *risk* surface.
|
|
66
|
+
- **mcpgawk does both** — cost **and** trust — locally, reproducibly, in one command.
|
|
67
|
+
|
|
68
|
+
## Features
|
|
69
|
+
|
|
70
|
+
- 🔌 **Any transport** — stdio, streamable-HTTP, SSE, and OAuth remotes (via the `mcp-remote` bridge).
|
|
71
|
+
- 💸 **Token cost index** — exactly what each tool adds to your context at connect.
|
|
72
|
+
- 🧾 **Capability facts** — write / exfil-capable / declared annotations, straight from the schema.
|
|
73
|
+
- 📌 **Integrity pin + drift** — catch a server that silently rewrites its tools (`--track`).
|
|
74
|
+
- 🚩 **Bounded signals** — injection-shaped descriptions, cross-server shadowing, under-declaring Server Cards — pointers for a human, never verdicts.
|
|
75
|
+
- 🔒 **Zero egress, by construction** — the measurement layers import no network library. Enforced by a test.
|
|
76
|
+
|
|
77
|
+
## Install
|
|
78
|
+
|
|
79
|
+
```bash
|
|
80
|
+
pip install mcpgawk # or: uv tool install mcpgawk
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
## Use
|
|
84
|
+
|
|
85
|
+
```bash
|
|
86
|
+
mcpgawk scan mcp.json # a whole config
|
|
87
|
+
mcpgawk scan --stdio "npx -y @modelcontextprotocol/server-filesystem /tmp"
|
|
88
|
+
mcpgawk scan --http https://host/mcp --header "Authorization: Bearer $TOKEN"
|
|
89
|
+
mcpgawk scan --sse https://host/sse
|
|
90
|
+
mcpgawk scan mcp.json --track # record + detect rug-pulls over time
|
|
91
|
+
mcpgawk scan mcp.json --json # machine-readable labels
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
## What it reports
|
|
95
|
+
|
|
96
|
+
- **Cost index** — tokens each tool adds at connect (named tokenizer; a comparable index, not an
|
|
97
|
+
absolute Claude count).
|
|
98
|
+
- **Capability facts** — write/mutating, exfil-capable, declared annotations.
|
|
99
|
+
- **Integrity pin** — a hash that changes if the server silently rewrites its tools; `--track`
|
|
100
|
+
turns it into rug-pull detection over time.
|
|
101
|
+
- **Bounded signals** — precise, low-false-positive pointers *for a human to review*, never verdicts:
|
|
102
|
+
injection-shaped descriptions (tools **and** prompts), cross-server name shadowing, and public
|
|
103
|
+
Server Cards that under-declare what the server actually exposes.
|
|
104
|
+
|
|
105
|
+
## Guarantees
|
|
106
|
+
|
|
107
|
+
- **No inventory egress.** The only network is the protocol client talking to the server you point
|
|
108
|
+
it at. The measurement layers import no network library — they *cannot* egress by construction
|
|
109
|
+
(enforced by a test). Public Server Card discovery is fetched with no auth and no redirect-following.
|
|
110
|
+
- **Facts ≠ heuristics.** Exact capability facts and the token index never mix with the bounded
|
|
111
|
+
heuristic signals — separate in code, separate in output.
|
|
112
|
+
- **Reproducible.** One command, identical numbers.
|
|
113
|
+
- **Rides protocol evolution.** Built on the official `mcp` SDK, which negotiates the protocol version.
|
|
114
|
+
|
|
115
|
+
## Develop
|
|
116
|
+
|
|
117
|
+
```bash
|
|
118
|
+
uv run --extra dev --with mcp --with tiktoken --with httpx python -m pytest -q
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
## Contributing
|
|
122
|
+
|
|
123
|
+
Issues and PRs welcome. Please read [CONTRIBUTING.md](CONTRIBUTING.md) first, and see the design
|
|
124
|
+
boundaries in [THREAT-MODEL.md](THREAT-MODEL.md). Security reports go through [SECURITY.md](SECURITY.md)
|
|
125
|
+
(privately, not a public issue).
|
|
126
|
+
|
|
127
|
+
## License
|
|
128
|
+
|
|
129
|
+
**Apache-2.0** — see [LICENSE](LICENSE). Part of the **nativerse** · gawk.dev family. The value is in the
|
|
130
|
+
repo, not a cloud.
|
mcpgawk-0.1.0/README.md
ADDED
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<picture>
|
|
3
|
+
<source media="(prefers-color-scheme: dark)" srcset="assets/brand/wordmark-dark.png">
|
|
4
|
+
<img alt="mcpgawk by nativerse" src="assets/brand/wordmark-light.png" width="320">
|
|
5
|
+
</picture>
|
|
6
|
+
</p>
|
|
7
|
+
<p align="center"><em>gawk at it before you trust it.</em></p>
|
|
8
|
+
|
|
9
|
+
# mcpgawk
|
|
10
|
+
|
|
11
|
+
[](https://pypi.org/project/mcpgawk/)
|
|
12
|
+
[](https://pypi.org/project/mcpgawk/)
|
|
13
|
+
[](LICENSE)
|
|
14
|
+
[](https://github.com/gawk-dev/mcpgawk/actions/workflows/ci.yml)
|
|
15
|
+
[](#guarantees)
|
|
16
|
+
|
|
17
|
+
**gawk at an MCP server before you trust it.** A single, local-first command that connects to any
|
|
18
|
+
[Model Context Protocol](https://modelcontextprotocol.io) server and measures what it will cost and
|
|
19
|
+
expose — **without the server's inventory ever leaving your machine.**
|
|
20
|
+
|
|
21
|
+
<p align="center">
|
|
22
|
+
<img src="assets/brand/demo.gif" alt="mcpgawk scanning an MCP server — tools, token cost, and capability flags, locally" width="760">
|
|
23
|
+
</p>
|
|
24
|
+
<p align="center"><sub>Real output. Reproducible on your machine — no account, nothing uploaded.</sub></p>
|
|
25
|
+
|
|
26
|
+
## Why
|
|
27
|
+
|
|
28
|
+
Every MCP server you connect dumps *all* its tool definitions into your model's context at connect
|
|
29
|
+
time — whether you use one tool or none. That's a hidden **token tax** and an unvetted **trust
|
|
30
|
+
surface**. mcpgawk measures both, **locally**, and never phones home about what it saw.
|
|
31
|
+
|
|
32
|
+
## How it's different
|
|
33
|
+
|
|
34
|
+
- **vs. cloud scanners** (e.g. Snyk/Invariant `mcp-scan`) — they upload your inventory to a server and
|
|
35
|
+
gate the verdict. mcpgawk runs entirely on your machine; nothing is uploaded, ever.
|
|
36
|
+
- **vs. lazy-load gateways** — they cut tokens but tell you nothing about the *risk* surface.
|
|
37
|
+
- **mcpgawk does both** — cost **and** trust — locally, reproducibly, in one command.
|
|
38
|
+
|
|
39
|
+
## Features
|
|
40
|
+
|
|
41
|
+
- 🔌 **Any transport** — stdio, streamable-HTTP, SSE, and OAuth remotes (via the `mcp-remote` bridge).
|
|
42
|
+
- 💸 **Token cost index** — exactly what each tool adds to your context at connect.
|
|
43
|
+
- 🧾 **Capability facts** — write / exfil-capable / declared annotations, straight from the schema.
|
|
44
|
+
- 📌 **Integrity pin + drift** — catch a server that silently rewrites its tools (`--track`).
|
|
45
|
+
- 🚩 **Bounded signals** — injection-shaped descriptions, cross-server shadowing, under-declaring Server Cards — pointers for a human, never verdicts.
|
|
46
|
+
- 🔒 **Zero egress, by construction** — the measurement layers import no network library. Enforced by a test.
|
|
47
|
+
|
|
48
|
+
## Install
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
pip install mcpgawk # or: uv tool install mcpgawk
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
## Use
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
mcpgawk scan mcp.json # a whole config
|
|
58
|
+
mcpgawk scan --stdio "npx -y @modelcontextprotocol/server-filesystem /tmp"
|
|
59
|
+
mcpgawk scan --http https://host/mcp --header "Authorization: Bearer $TOKEN"
|
|
60
|
+
mcpgawk scan --sse https://host/sse
|
|
61
|
+
mcpgawk scan mcp.json --track # record + detect rug-pulls over time
|
|
62
|
+
mcpgawk scan mcp.json --json # machine-readable labels
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
## What it reports
|
|
66
|
+
|
|
67
|
+
- **Cost index** — tokens each tool adds at connect (named tokenizer; a comparable index, not an
|
|
68
|
+
absolute Claude count).
|
|
69
|
+
- **Capability facts** — write/mutating, exfil-capable, declared annotations.
|
|
70
|
+
- **Integrity pin** — a hash that changes if the server silently rewrites its tools; `--track`
|
|
71
|
+
turns it into rug-pull detection over time.
|
|
72
|
+
- **Bounded signals** — precise, low-false-positive pointers *for a human to review*, never verdicts:
|
|
73
|
+
injection-shaped descriptions (tools **and** prompts), cross-server name shadowing, and public
|
|
74
|
+
Server Cards that under-declare what the server actually exposes.
|
|
75
|
+
|
|
76
|
+
## Guarantees
|
|
77
|
+
|
|
78
|
+
- **No inventory egress.** The only network is the protocol client talking to the server you point
|
|
79
|
+
it at. The measurement layers import no network library — they *cannot* egress by construction
|
|
80
|
+
(enforced by a test). Public Server Card discovery is fetched with no auth and no redirect-following.
|
|
81
|
+
- **Facts ≠ heuristics.** Exact capability facts and the token index never mix with the bounded
|
|
82
|
+
heuristic signals — separate in code, separate in output.
|
|
83
|
+
- **Reproducible.** One command, identical numbers.
|
|
84
|
+
- **Rides protocol evolution.** Built on the official `mcp` SDK, which negotiates the protocol version.
|
|
85
|
+
|
|
86
|
+
## Develop
|
|
87
|
+
|
|
88
|
+
```bash
|
|
89
|
+
uv run --extra dev --with mcp --with tiktoken --with httpx python -m pytest -q
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
## Contributing
|
|
93
|
+
|
|
94
|
+
Issues and PRs welcome. Please read [CONTRIBUTING.md](CONTRIBUTING.md) first, and see the design
|
|
95
|
+
boundaries in [THREAT-MODEL.md](THREAT-MODEL.md). Security reports go through [SECURITY.md](SECURITY.md)
|
|
96
|
+
(privately, not a public issue).
|
|
97
|
+
|
|
98
|
+
## License
|
|
99
|
+
|
|
100
|
+
**Apache-2.0** — see [LICENSE](LICENSE). Part of the **nativerse** · gawk.dev family. The value is in the
|
|
101
|
+
repo, not a cloud.
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# Security
|
|
2
|
+
|
|
3
|
+
mcpgawk is a **local-first** tool: it connects only to the MCP server you point it at, and never uploads
|
|
4
|
+
your inventory anywhere. The design and its boundaries are documented in [THREAT-MODEL.md](THREAT-MODEL.md).
|
|
5
|
+
|
|
6
|
+
## Reporting a vulnerability
|
|
7
|
+
|
|
8
|
+
If you find a security issue **in mcpgawk itself** (e.g. a way it could leak inventory, follow a redirect
|
|
9
|
+
with credentials, or execute untrusted content), please report it privately rather than opening a public issue:
|
|
10
|
+
|
|
11
|
+
- Open a [GitHub security advisory](../../security/advisories/new), or
|
|
12
|
+
- email **security@gawk.dev**.
|
|
13
|
+
|
|
14
|
+
Please include: what you did, what you expected, what happened, and a minimal reproduction. We aim to
|
|
15
|
+
acknowledge within a few days.
|
|
16
|
+
|
|
17
|
+
## Scope
|
|
18
|
+
|
|
19
|
+
- **In scope:** inventory egress, credential handling (Server Card fetch is deliberately unauthenticated and
|
|
20
|
+
does not follow redirects), the EXACT / BOUNDED / INDEX separation, and any way the tool could be made to
|
|
21
|
+
act on content from a scanned server.
|
|
22
|
+
- **Out of scope:** findings *about a third-party MCP server* that mcpgawk reports on. mcpgawk's signals are
|
|
23
|
+
**bounded pointers for a human to review, never verdicts** — a flagged tool is not a vulnerability report.
|