python-alfresco-mcp-server 1.1.0__tar.gz → 1.2.1__tar.gz

python_alfresco_mcp_server-1.2.1/.gitignore

@@ -0,0 +1,250 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Additional testing framework artifacts
+.pytest_cache/
+pytest.ini.bak
+test-results/
+test-reports/
+.testmondata
+junit.xml
+report.xml
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# VS Code
+.vscode/settings.json
+.vscode/launch.json
+.vscode/extensions.json
+.vscode/tasks.json
+.vscode/.ropeproject
+# Keep workspace settings but ignore personal settings
+!.vscode/settings.json.template
+!.vscode/mcp.json
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor  
+#  Cursor is an AI-powered code editor.`.cursorignore` specifies files/directories to 
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+*.cursormemory
+.cursormemory
+memory-bank/
+
+# FastMCP 2.0 and MCP Development
+# MCP client/server communication logs
+*.mcp.log
+mcp_*.log
+fastmcp_*.log
+
+# MCP development artifacts
+.mcp_cache/
+mcp_debug/
+.fastmcp/
+
+# Alfresco MCP Server specific
+alfresco_mcp_server.log*
+alfresco_*.log
+connection_test.py
+debug_*.py
+
+# Development and testing artifacts
+.benchmarks/
+performance_results/
+integration_test_results/
+mock_data/
+test_uploads/
+test_downloads/
+
+# Configuration files with secrets (keep templates)
+config.local.yaml
+config.dev.yaml
+config.prod.yaml
+.env.local
+.env.dev
+.env.prod
+# Keep sample config files
+!sample-*.txt
+!config.sample.*
+!.env.sample
+
+# Experimental/scratch files
+o.txt
+*.tmp
+test_*.py
+*_test.py
+scratch*
+temp*
+debug_output.txt
+output.txt

python_alfresco_mcp_server-1.2.1/CHANGELOG.md

@@ -0,0 +1,173 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.2.1] - 2026-09-29
+
+### Added
+- **`ALFRESCO_TICKET`**: with `ALFRESCO_AUTH_METHOD=ticket`, a login ticket you already hold is used as-is instead of being fetched from a username and password — so the server can run with no Alfresco password configured at all. Leave it unset and ticket auth behaves as before (acquired from `ALFRESCO_USERNAME` / `ALFRESCO_PASSWORD`). A supplied ticket is never renewed, so it stops working when it expires.
+
+### Changed
+- Requires **python-alfresco-api >= 1.2.2** for the ticket pass-through above.
+
+### Fixed
+- **Integration test `test_search_shared_folder`**: now passes `node_type="cm:folder"`. `search_content` searches documents (`cm:content`) by default, so the search never matched the Shared folder and the test failed.
+
+## [1.2.0] - 2026-08-05
+
+### Added
+- **Alfresco auth methods** (`ALFRESCO_AUTH_METHOD` = `basic` | `ticket` | `oauth2`): the server can now authenticate to Alfresco via HTTP Basic, a login ticket, or an OAuth2/OIDC bearer token (Alfresco `identity-service`), via `python-alfresco-api` 1.2.1+ `OAuth2AuthUtil`, configured with `ALFRESCO_OAUTH2_*` env vars. Documents the setup in the README **Authentication** section (addresses #2). Live-tested basic/ticket/oauth2 end-to-end.
+- **Optional MCP transport authentication** (`MCP_TRANSPORT_AUTH=true`): secures the MCP server itself — HTTP/SSE callers must present an OAuth2 bearer token, validated against an OIDC IdP's JWKS (FastMCP JWT verifier). Off by default; stdio unaffected. Env: `MCP_AUTH_JWKS_URI` / `MCP_AUTH_ISSUER` / `MCP_AUTH_AUDIENCE`.
+- **`download_document` `destination_dir`**: optional custom download folder (default `~/Downloads`). Thanks [@jeremie-lesage](https://github.com/jeremie-lesage) ([#1](https://github.com/stevereiner/python-alfresco-mcp-server/pull/1)).
+
+### Changed
+- **Version 1.2.0** of this package; requires **python-alfresco-api >= 1.2.1** (OAuth2/OIDC auth, `VersionsClient` fix, and OAuth2 service-account `displayName` handling — see below).
+- **Config layout**: moved Claude Desktop sample configs into [`claude-desktop-configs/`](./claude-desktop-configs/) and MCP Inspector samples into [`mcp-inspector-configs/`](./mcp-inspector-configs/); docs and README updated accordingly.
+- **FastMCP 3 upgrade**: bumped dependency from FastMCP 2.x to `fastmcp>=3.4.5,<4`. Server code is compatible with FastMCP 3's API (`list_tools()` / `list_resources()` / `list_prompts()`); JWT transport auth now uses `JWTVerifier` directly. See [FastMCP 2 → 3 upgrade guide](https://gofastmcp.com/getting-started/upgrading/from-fastmcp-2).
+- **Packaging**: switched build backend from setuptools to hatchling (same as python-alfresco-api) for quieter `uv build` output.
+
+### Fixed
+- **checkout_document**: local download filename puts the node ID before the extension (`name_<nodeId>.txt`) instead of after it (`name.txt_<nodeId>`), so editors keep the correct file type.
+- **OAuth2 service-account nodes** (via **python-alfresco-api 1.2.1**): Keycloak client-credentials authenticates as a JIT Alfresco user with no display name, so Alfresco returns `createdByUser` / `modifiedByUser` / `owner` without `displayName` and the generated `UserInfo.from_dict` raised `KeyError('displayName')` (breaking `download_document` and other `nodes.get` tools). Fixed upstream with a runtime shim (`python_alfresco_api/_compat.py`, applied at package import) that defaults missing `displayName` to `id` for core and search `UserInfo` — outside `raw_clients/` so it survives client re-generation. Basic/ticket and user-based OAuth2 tokens were unaffected.
+
+## [1.1.0] - 2025-01-25
+
+### Alfresco_MCP_Server dir code changes for v1.1
+- **Code Split**: Refactored from monolithic single file to modular structure with separate files
+- **Directory Structure**: Reorganized from flat to hierarchical structure
+  - `tools/search/` - 4 search-related tools
+  - `tools/core/` - 11 core management tools
+  - `resources/` - Repository information
+  - `prompts/` - AI templates
+  - `utils/` - Shared utilities  
+- fix: implement Windows UTF-8 encoding support (emoji character encoding)
+- get to work with python-alfresco-api 1.1.x
+- add imports and __all__ to get files included in packaging
+
+### UV Package Management Support
+- **Rust-based Performance**: UV provides faster dependency resolution and package management
+- **Automatic Environment Management**: UV handles virtual environment creation and activation
+- **Simplified Installation**: One-command setup replaces multi-step manual process
+- **Cross-platform Compatibility**: Consistent behavior across Windows, macOS, and Linux
+
+### PyPI Distribution
+- **Direct Installation**: Available via `pip install python-alfresco-mcp-server`
+- **UV Integration**: Compatible with `uv pip install python-alfresco-mcp-server`
+- **Immediate Usage**: Run server directly after installation without source code
+
+### Update Tests for v1.1
+- `test: transform test suite from 76+ failures to 143/143 passing`
+- `test: add comprehensive live integration testing with 21 Alfresco tests`
+- `test: implement cross-platform emoji handling for Windows compatibility`
+- `test: enhance coverage reporting with HTML output`
+- `test: add automated testing for all manual scenarios`
+- `test: implement strip_emojis() function for Windows compatibility`
+- `test: add comprehensive unit test coverage (122 tests)`
+- `test: fix test import paths for modular architecture`
+
+### MCP Clients: config files added for v1.1
+-  Added Claude Desktop and MCP Inspector config files
+- `config: added claude-desktop-config-developer-windows.json with UV support`
+- `config: added claude-desktop-config-developer-macos.json with UV support`
+- `config: added claude-desktop-config-user-windows.json`
+- `config: added claude-desktop-config-user-macos.json`
+- `config: added Windows UTF-8 encoding variables to windows configs`
+- `config: added mcp-inspector-http-config.json for HTTP transport using uv`
+- `config: added mcp-inspector-stdio-config.json for STDIO transport using uv`
+- 'examples: prompts-for-claude.md has example prompt text to test tools
+
+### Update docs for v1.1
+- `docs: create comprehensive CHANGELOG.md for v1.0.0 and v1.1.0`
+- `docs: update quick start guide for UV approach`
+- 'docs: api_reference.md added details for all tools, etc
+- `docs: added claude_desktop_setup.md, mcp_inspector_setup.md, and client_configurations.md
+
+### Documentation Updates for v1.1
+- **Installation Instructions**: Added PyPI installation methods
+- **Configuration Examples**: Updated for UV approach
+- **Testing Procedures**: Comprehensive test execution guidance
+- **Troubleshooting**: Enhanced problem resolution guidance
+
+### Update Readme for v1.1
+- added install from PyPI 
+- added how to install UV package manager
+- added claude desktop and mcp inspector setup sections
+- reword technical sections for accuracy
+- add v1.1 list of changes, depend on python-alfresco 1.1.1, python 3.10+
+- added how to install Alfresco Community from github
+
+### Update project files and misc root dir files for v1.1
+- gitignore now ignores cursor memory and memory-bank dir, keep .vscode/mcp.json
+- config.yaml has changed alfresco_url to have base_url, added timeout, added
+  mcp server name and version confg
+- MANIFEST.in added for proper package distrubution config
+- pyproject.toml change to have v1.1.0 release, pypi distrib settings, remove
+  fastMCP version restriction, update to require python 3.10 or greater, add
+  pypi keyword and topic, settings, project urls for pypi, configure setuptools
+  for includes, excludes
+- run_server.py script added
+- .vscode/mcp.json  uses run_server.py for debugging mcp server
+-  uv.lock add now that use uv, and uv lock --upgrade updated v0.12.5 from v0.12.4 of ruff
+
+### Fixes for pyproject.toml  for v1.1
+ - require python-alfresco-api >= 1.1.1 not 1.0.0 in dependencies
+ - have python 3.10 instead of 3.8 for tool.mypy, and py310 not py38 for tool.ruff and tool.black
+ 
+### Example Code Updates for v1.1
+- `examples: update transport examples for UV approach`
+- `examples: enhance document lifecycle example`
+- `examples: add UV-specific installation examples`
+- `examples: update batch operations for improved performance`
+- `examples: refactor error handling patterns` 
+
+### Requirements
+- **Python Versions**: 3.10+ (unchanged)
+- **python-alfresco-api**: >= 1.1.1 (updated requirement)
+- **FastMCP**: Tested with v2.10.6
+
+### Tested
+- **Alfresco Versions**: Community 25.1 (tested), Enterprise (not tested in v1.1)
+- **Operating Systems**: 
+  - Windows (tested)
+  - macOS (needs testing)
+  - Linux (needs testing, note: no Claude Desktop support on Linux)
+- **MCP Clients**: 
+  - Claude Desktop (tested and validated)
+  - MCP Inspector (tested and validated)
+  - Cursor (configuration provided, not tested in v1.1)
+  - Claude Code (configuration provided, not tested in v1.1) 
+
+## [1.0.0] - 2024-06-24
+
+### Added
+- Initial FastMCP 2.0 server implementation
+- 15 content management tools across search and core operations
+- Full text search with wildcard support
+- Advanced search using AFTS query language
+- Metadata search with property-based queries
+- CMIS SQL search capabilities
+- Complete document lifecycle management (upload, download, checkout, checkin)
+- Version management with major/minor version support
+- Folder operations and repository browsing
+- Property management for documents and folders
+- Multiple transport protocols (STDIO, HTTP, SSE)
+- Configuration via environment variables and .env files
+- Claude Desktop integration with Windows and macOS configs
+- MCP Inspector support for development testing
+- Comprehensive documentation and examples
+- Testing framework with unit and integration tests
+- Error handling and recovery patterns
+- Repository discovery and status reporting
+
+### Technical Implementation
+- python-alfresco-api integration for content services access
+- Pydantic v2 models for type safety
+- Async support for concurrent operations
+- Connection pooling and authentication management
+- Progress reporting and context logging
+- Configuration validation and environment setup