mcp-compressor 0.0.2__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 @@
1
+ tesler
@@ -0,0 +1,30 @@
1
+ name: "Setup Python Environment"
2
+ description: "Set up Python environment for the given Python version"
3
+
4
+ inputs:
5
+ python-version:
6
+ description: "Python version to use"
7
+ required: true
8
+ default: "3.12"
9
+ uv-version:
10
+ description: "uv version to use"
11
+ required: true
12
+ default: "0.9.16"
13
+
14
+ runs:
15
+ using: "composite"
16
+ steps:
17
+ - uses: actions/setup-python@v5
18
+ with:
19
+ python-version: ${{ inputs.python-version }}
20
+
21
+ - name: Install uv
22
+ uses: astral-sh/setup-uv@v6
23
+ with:
24
+ version: ${{ inputs.uv-version }}
25
+ enable-cache: 'true'
26
+ cache-suffix: ${{ matrix.python-version }}
27
+
28
+ - name: Install Python dependencies
29
+ run: uv sync --frozen
30
+ shell: bash
@@ -0,0 +1,62 @@
1
+ name: Main
2
+
3
+ on:
4
+ push:
5
+ branches:
6
+ - main
7
+ pull_request:
8
+ types: [opened, synchronize, reopened, ready_for_review]
9
+
10
+ jobs:
11
+ quality:
12
+ runs-on: ubuntu-latest
13
+ steps:
14
+ - name: Check out
15
+ uses: actions/checkout@v4
16
+
17
+ - uses: actions/cache@v4
18
+ with:
19
+ path: ~/.cache/pre-commit
20
+ key: pre-commit-${{ hashFiles('.pre-commit-config.yaml') }}
21
+
22
+ - name: Set up the environment
23
+ uses: ./.github/actions/setup-python-env
24
+
25
+ - name: Run checks
26
+ run: make check
27
+
28
+ tests-and-type-check:
29
+ runs-on: ubuntu-latest
30
+ strategy:
31
+ matrix:
32
+ python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
33
+ fail-fast: false
34
+ defaults:
35
+ run:
36
+ shell: bash
37
+ steps:
38
+ - name: Check out
39
+ uses: actions/checkout@v4
40
+
41
+ - name: Set up the environment
42
+ uses: ./.github/actions/setup-python-env
43
+ with:
44
+ python-version: ${{ matrix.python-version }}
45
+
46
+ - name: Run tests
47
+ run: uv run python -m pytest tests
48
+
49
+ - name: Check typing
50
+ run: uv run ty check
51
+
52
+ check-docs:
53
+ runs-on: ubuntu-latest
54
+ steps:
55
+ - name: Check out
56
+ uses: actions/checkout@v4
57
+
58
+ - name: Set up the environment
59
+ uses: ./.github/actions/setup-python-env
60
+
61
+ - name: Check if documentation can be built
62
+ run: uv run mkdocs build -s
@@ -0,0 +1,65 @@
1
+ name: release-main
2
+
3
+ on:
4
+ release:
5
+ types: [published]
6
+
7
+ jobs:
8
+ set-version:
9
+ runs-on: ubuntu-24.04
10
+ steps:
11
+ - uses: actions/checkout@v4
12
+
13
+ - name: Export tag
14
+ id: vars
15
+ run: echo tag=${GITHUB_REF#refs/*/} >> $GITHUB_OUTPUT
16
+ if: ${{ github.event_name == 'release' }}
17
+
18
+ - name: Update project version
19
+ run: |
20
+ sed -i "s/^version = \".*\"/version = \"$RELEASE_VERSION\"/" pyproject.toml
21
+ env:
22
+ RELEASE_VERSION: ${{ steps.vars.outputs.tag }}
23
+ if: ${{ github.event_name == 'release' }}
24
+
25
+ - name: Upload updated pyproject.toml
26
+ uses: actions/upload-artifact@v4
27
+ with:
28
+ name: pyproject-toml
29
+ path: pyproject.toml
30
+
31
+ publish:
32
+ runs-on: ubuntu-latest
33
+ needs: [set-version]
34
+ permissions:
35
+ id-token: write
36
+ steps:
37
+ - name: Check out
38
+ uses: actions/checkout@v4
39
+
40
+ - name: Set up the environment
41
+ uses: ./.github/actions/setup-python-env
42
+
43
+ - name: Download updated pyproject.toml
44
+ uses: actions/download-artifact@v4
45
+ with:
46
+ name: pyproject-toml
47
+
48
+ - name: Build package
49
+ run: uv build
50
+
51
+ - name: Publish package
52
+ run: uv publish --trusted-publishing always
53
+
54
+ deploy-docs:
55
+ needs: publish
56
+ runs-on: ubuntu-latest
57
+ steps:
58
+ - name: Check out
59
+ uses: actions/checkout@v4
60
+
61
+ - name: Set up the environment
62
+ uses: ./.github/actions/setup-python-env
63
+
64
+ - name: Deploy documentation
65
+ run: uv run mkdocs gh-deploy --force
@@ -0,0 +1,211 @@
1
+ docs/source
2
+
3
+ # From https://raw.githubusercontent.com/github/gitignore/main/Python.gitignore
4
+
5
+ # Byte-compiled / optimized / DLL files
6
+ __pycache__/
7
+ *.py[codz]
8
+ *$py.class
9
+
10
+ # C extensions
11
+ *.so
12
+
13
+ # Distribution / packaging
14
+ .Python
15
+ build/
16
+ develop-eggs/
17
+ dist/
18
+ downloads/
19
+ eggs/
20
+ .eggs/
21
+ lib/
22
+ lib64/
23
+ parts/
24
+ sdist/
25
+ var/
26
+ wheels/
27
+ share/python-wheels/
28
+ *.egg-info/
29
+ .installed.cfg
30
+ *.egg
31
+ MANIFEST
32
+
33
+ # PyInstaller
34
+ # Usually these files are written by a python script from a template
35
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
36
+ *.manifest
37
+ *.spec
38
+
39
+ # Installer logs
40
+ pip-log.txt
41
+ pip-delete-this-directory.txt
42
+
43
+ # Unit test / coverage reports
44
+ htmlcov/
45
+ .tox/
46
+ .nox/
47
+ .coverage
48
+ .coverage.*
49
+ .cache
50
+ nosetests.xml
51
+ coverage.xml
52
+ *.cover
53
+ *.py.cover
54
+ .hypothesis/
55
+ .pytest_cache/
56
+ cover/
57
+
58
+ # Translations
59
+ *.mo
60
+ *.pot
61
+
62
+ # Django stuff:
63
+ *.log
64
+ local_settings.py
65
+ db.sqlite3
66
+ db.sqlite3-journal
67
+
68
+ # Flask stuff:
69
+ instance/
70
+ .webassets-cache
71
+
72
+ # Scrapy stuff:
73
+ .scrapy
74
+
75
+ # Sphinx documentation
76
+ docs/_build/
77
+
78
+ # PyBuilder
79
+ .pybuilder/
80
+ target/
81
+
82
+ # Jupyter Notebook
83
+ .ipynb_checkpoints
84
+
85
+ # IPython
86
+ profile_default/
87
+ ipython_config.py
88
+
89
+ # pyenv
90
+ # For a library or package, you might want to ignore these files since the code is
91
+ # intended to run in multiple environments; otherwise, check them in:
92
+ # .python-version
93
+
94
+ # pipenv
95
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
96
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
97
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
98
+ # install all needed dependencies.
99
+ #Pipfile.lock
100
+
101
+ # UV
102
+ # Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
103
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
104
+ # commonly ignored for libraries.
105
+ #uv.lock
106
+
107
+ # poetry
108
+ # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
109
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
110
+ # commonly ignored for libraries.
111
+ # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
112
+ #poetry.lock
113
+ #poetry.toml
114
+
115
+ # pdm
116
+ # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
117
+ # pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
118
+ # https://pdm-project.org/en/latest/usage/project/#working-with-version-control
119
+ #pdm.lock
120
+ #pdm.toml
121
+ .pdm-python
122
+ .pdm-build/
123
+
124
+ # pixi
125
+ # Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
126
+ #pixi.lock
127
+ # Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
128
+ # in the .venv directory. It is recommended not to include this directory in version control.
129
+ .pixi
130
+
131
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
132
+ __pypackages__/
133
+
134
+ # Celery stuff
135
+ celerybeat-schedule
136
+ celerybeat.pid
137
+
138
+ # SageMath parsed files
139
+ *.sage.py
140
+
141
+ # Environments
142
+ .env
143
+ .envrc
144
+ .venv
145
+ env/
146
+ venv/
147
+ ENV/
148
+ env.bak/
149
+ venv.bak/
150
+
151
+ # Spyder project settings
152
+ .spyderproject
153
+ .spyproject
154
+
155
+ # Rope project settings
156
+ .ropeproject
157
+
158
+ # mkdocs documentation
159
+ /site
160
+
161
+ # mypy
162
+ .mypy_cache/
163
+ .dmypy.json
164
+ dmypy.json
165
+
166
+ # Pyre type checker
167
+ .pyre/
168
+
169
+ # pytype static type analyzer
170
+ .pytype/
171
+
172
+ # Cython debug symbols
173
+ cython_debug/
174
+
175
+ # PyCharm
176
+ # JetBrains specific template is maintained in a separate JetBrains.gitignore that can
177
+ # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
178
+ # and can be added to the global gitignore or merged into this file. For a more nuclear
179
+ # option (not recommended) you can uncomment the following to ignore the entire idea folder.
180
+ #.idea/
181
+
182
+ # Abstra
183
+ # Abstra is an AI-powered process automation framework.
184
+ # Ignore directories containing user credentials, local state, and settings.
185
+ # Learn more at https://abstra.io/docs
186
+ .abstra/
187
+
188
+ # Visual Studio Code
189
+ # Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
190
+ # that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
191
+ # and can be added to the global gitignore or merged into this file. However, if you prefer,
192
+ # you could uncomment the following to ignore the entire vscode folder
193
+ # .vscode/
194
+
195
+ # Ruff stuff:
196
+ .ruff_cache/
197
+
198
+ # PyPI configuration file
199
+ .pypirc
200
+
201
+ # Cursor
202
+ # Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
203
+ # exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
204
+ # refer to https://docs.cursor.com/context/ignore-files
205
+ .cursorignore
206
+ .cursorindexingignore
207
+
208
+ # Marimo
209
+ marimo/_static/
210
+ marimo/_lsp/
211
+ __marimo__/
@@ -0,0 +1,21 @@
1
+ repos:
2
+ - repo: https://github.com/pre-commit/pre-commit-hooks
3
+ rev: "v6.0.0"
4
+ hooks:
5
+ - id: check-case-conflict
6
+ - id: check-merge-conflict
7
+ - id: check-toml
8
+ - id: check-json
9
+ exclude: ^.devcontainer/devcontainer.json
10
+ - id: pretty-format-json
11
+ exclude: ^.devcontainer/devcontainer.json
12
+ args: [--autofix, --no-sort-keys]
13
+ - id: end-of-file-fixer
14
+ - id: trailing-whitespace
15
+
16
+ - repo: https://github.com/astral-sh/ruff-pre-commit
17
+ rev: "v0.14.8"
18
+ hooks:
19
+ - id: ruff-check
20
+ args: [ --exit-non-zero-on-fix ]
21
+ - id: ruff-format
@@ -0,0 +1,27 @@
1
+ # Contributor Code of Conduct
2
+
3
+ As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
4
+
5
+ We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality.
6
+
7
+ Examples of unacceptable behavior by participants include:
8
+
9
+ * The use of sexualized language or imagery
10
+ * Personal attacks
11
+ * Trolling or insulting/derogatory comments
12
+ * Public or private harassment
13
+ * Publishing other's private information, such as physical or electronic addresses, without explicit permission
14
+ * Submitting contributions or comments that you know to violate the intellectual property or privacy rights of others
15
+ * Other unethical or unprofessional conduct
16
+
17
+ Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
18
+ By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team.
19
+
20
+ This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.
21
+
22
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting a project maintainer. Complaints will result in a response and be reviewed and investigated in a way that is deemed necessary and appropriate to the circumstances. Maintainers are obligated to maintain confidentiality with regard to the reporter of an incident.
23
+
24
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.3.0, available at [http://contributor-covenant.org/version/1/3/0/][version]
25
+
26
+ [homepage]: http://contributor-covenant.org
27
+ [version]: http://contributor-covenant.org/version/1/3/0/
@@ -0,0 +1,134 @@
1
+ # Contributing to `mcp-compressor`
2
+
3
+ Contributions are welcome, and they are greatly appreciated!
4
+ Every little bit helps, and credit will always be given.
5
+
6
+ Pull requests, issues and comments are welcome. For pull requests, please:
7
+
8
+ * Add tests for new features and bug fixes
9
+ * Follow the existing style
10
+ * Separate unrelated changes into multiple pull requests
11
+
12
+ For bigger changes, please make sure you start a discussion first by creating an issue and explaining the intended change.
13
+
14
+ You can contribute in many ways:
15
+
16
+ # Types of Contributions
17
+
18
+ ## Report Bugs
19
+
20
+ Report bugs at https://github.com/atlassian-labs/mcp-compressor/issues
21
+
22
+ If you are reporting a bug, please include:
23
+
24
+ - Your operating system name and version.
25
+ - Any details about your local setup that might be helpful in troubleshooting.
26
+ - Detailed steps to reproduce the bug.
27
+
28
+ ## Fix Bugs
29
+
30
+ Look through the GitHub issues for bugs.
31
+ Anything tagged with "bug" and "help wanted" is open to whoever wants to implement a fix for it.
32
+
33
+ ## Implement Features
34
+
35
+ Look through the GitHub issues for features.
36
+ Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.
37
+
38
+ ## Write Documentation
39
+
40
+ mcp-compressor could always use more documentation, whether as part of the official docs, in docstrings, or even on the web in blog posts, articles, and such.
41
+
42
+ ## Submit Feedback
43
+
44
+ The best way to send feedback is to file an issue at https://github.com/atlassian-labs/mcp-compressor/issues.
45
+
46
+ If you are proposing a new feature:
47
+
48
+ - Explain in detail how it would work.
49
+ - Keep the scope as narrow as possible, to make it easier to implement.
50
+ - Remember that this is a volunteer-driven project, and that contributions
51
+ are welcome :)
52
+
53
+ # Get Started!
54
+
55
+ Ready to contribute? Here's how to set up `mcp-compressor` for local development.
56
+ Please note this documentation assumes you already have `uv` and `Git` installed and ready to go.
57
+
58
+ 1. Fork the `mcp-compressor` repo on GitHub.
59
+
60
+ 2. Clone your fork locally:
61
+
62
+ ```bash
63
+ cd <directory_in_which_repo_should_be_created>
64
+ git clone git@github.com:YOUR_NAME/mcp-compressor.git
65
+ ```
66
+
67
+ 3. Now we need to install the environment. Navigate into the directory
68
+
69
+ ```bash
70
+ cd mcp-compressor
71
+ ```
72
+
73
+ Then, install and activate the environment with:
74
+
75
+ ```bash
76
+ uv sync
77
+ ```
78
+
79
+ 4. Install pre-commit to run linters/formatters at commit time:
80
+
81
+ ```bash
82
+ uv run pre-commit install
83
+ ```
84
+
85
+ 5. Create a branch for local development:
86
+
87
+ ```bash
88
+ git checkout -b name-of-your-bugfix-or-feature
89
+ ```
90
+
91
+ Now you can make your changes locally.
92
+
93
+ 6. Don't forget to add test cases for your added functionality to the `tests` directory.
94
+
95
+ 7. When you're done making changes, check that your changes pass the formatting tests.
96
+
97
+ ```bash
98
+ make check
99
+ ```
100
+
101
+ Now, validate that all unit tests are passing:
102
+
103
+ ```bash
104
+ make test
105
+ ```
106
+
107
+ 9. Before raising a pull request you should also run tox.
108
+ This will run the tests across different versions of Python:
109
+
110
+ ```bash
111
+ tox
112
+ ```
113
+
114
+ This requires you to have multiple versions of python installed.
115
+ This step is also triggered in the CI/CD pipeline, so you could also choose to skip this step locally.
116
+
117
+ 10. Commit your changes and push your branch to GitHub:
118
+
119
+ ```bash
120
+ git add .
121
+ git commit -m "Your detailed description of your changes."
122
+ git push origin name-of-your-bugfix-or-feature
123
+ ```
124
+
125
+ 11. Submit a pull request through the GitHub website.
126
+
127
+ # Pull Request Guidelines
128
+
129
+ Before you submit a pull request, check that it meets these guidelines:
130
+
131
+ 1. The pull request should include tests.
132
+
133
+ 2. If the pull request adds functionality, the docs should be updated.
134
+ Put your new functionality into a function with a docstring, and add the feature to the list in `README.md`.