ibm-mdm-mcp-server 1.0.9__tar.gz

ibm_mdm_mcp_server-1.0.9/CHANGELOG.md

@@ -0,0 +1,144 @@
+<!--
+This file has been modified with the assistance of IBM Bob (AI Code Assistant)
+-->
+
+# Changelog
+
+All notable changes to the IBM MDM MCP Server 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]
+
+### Added
+- Comprehensive sample queries documentation (SAMPLES.md) with report templates and usage patterns
+- Security best practices section in README for API key management
+- Dashboard and visualization templates for data analysis
+- Client-agnostic documentation (works with any MCP-compatible client)
+
+### Changed
+- Updated documentation to use generic placeholders instead of assuming specific entity types
+- Reorganized sample queries with report templates positioned near usage patterns
+- Enhanced common usage patterns with concrete, actionable examples
+
+## [1.0.0] - 2026-01-16
+
+### Added
+- Initial public release of IBM MDM MCP Server
+- Model Context Protocol (MCP) server implementation for IBM Master Data Management
+- Support for IBM MDM SaaS on IBM Cloud platform
+- Support for IBM MDM on Software Hub (CPD) platform
+- Token-based authentication with automatic caching
+- Session management with configurable session stores
+- CRN (Cloud Resource Name) validation for IBM Cloud instances
+
+#### Core Features
+- **Search Functionality**: Advanced record search with flexible query parameters
+- **Data Model Access**: Retrieve complete MDM data model schemas
+- **Record Operations**: Get specific records by ID (full mode)
+- **Entity Operations**: Retrieve entities and their associations (full mode)
+
+#### Architecture
+- Clean 3-tier layered architecture inspired by hexagonal principles
+- Adapter pattern for platform-specific API implementations
+- Base service and adapter classes for consistent patterns
+- Pydantic models for type-safe data validation
+- Comprehensive error handling and logging
+
+#### Tools & Modes
+- **Minimal Mode**: Essential tools (`search_master_data`, `get_data_model`)
+- **Full Mode**: All tools including record/entity retrieval operations
+- **HTTP Mode**: Server mode for testing and development
+- **STDIO Mode**: Integration mode for Claude Desktop and MCP clients
+
+#### Configuration & Setup
+- Automated setup wizard (`setup.py`) for easy installation
+- Virtual environment management
+- Interactive configuration for both IBM Cloud and Software Hub platforms
+- Claude Desktop integration with automatic config generation
+- Environment-based configuration with `.env` file support
+
+#### Testing
+- Comprehensive test suite using pytest
+- Unit tests for authentication, session management, and validation
+- Test coverage reporting with pytest-cov
+- SonarQube/SonarCloud integration for code quality analysis
+
+#### Documentation
+- Detailed README with quick start guide
+- Architecture documentation (ARCHITECTURE.md)
+- Setup guide (SETUP_GUIDE.md)
+- API documentation and usage examples
+- Troubleshooting guide
+
+#### Security
+- Secure token caching mechanism
+- Environment-based credential management
+- Input validation and sanitization
+- CRN format validation for IBM Cloud
+
+#### Dependencies
+- Python 3.10+ requirement
+- FastMCP framework for MCP server implementation
+- Pydantic for data validation
+- httpx for HTTP client operations
+- python-dotenv for environment configuration
+- PyJWT for JWT token handling
+
+---
+
+## Release Notes
+
+### Version 1.0.0 (2026-01-16)
+
+This is the initial release of the IBM MDM MCP Server, providing AI assistants with seamless access to IBM Master Data Management services through the Model Context Protocol.
+
+**Key Highlights:**
+- 🔌 Full MCP protocol support for AI assistant integration
+- 🌐 Multi-platform compatibility (IBM Cloud & Software Hub)
+- 🔐 Secure authentication with token caching
+- 🛠️ Flexible tool modes (minimal/full)
+- 📊 Type-safe implementation with Pydantic
+- 🏗️ Clean, maintainable architecture
+- 🚀 One-command automated setup
+
+**Getting Started:**
+```bash
+git clone https://github.com/IBM/mdm-mcp-server.git
+cd mdm-mcp-server
+python setup.py
+```
+
+**Supported Platforms:**
+- IBM MDM SaaS on IBM Cloud
+- IBM MDM on Software Hub (CPD)
+
+**Integration:**
+- Claude Desktop (STDIO mode)
+- MCP Inspector (HTTP mode)
+- Custom MCP clients
+
+For detailed installation and usage instructions, see the [README](README.md).
+
+---
+
+## Contributing
+
+When contributing to this project, please update this CHANGELOG.md file with your changes under the `[Unreleased]` section following these categories:
+
+- **Added** for new features
+- **Changed** for changes in existing functionality
+- **Deprecated** for soon-to-be removed features
+- **Removed** for now removed features
+- **Fixed** for any bug fixes
+- **Security** for vulnerability fixes
+
+---
+
+## Links
+
+- [Repository](https://github.com/IBM/mdm-mcp-server)
+- [Issues](https://github.com/IBM/mdm-mcp-server/issues)
+- [Documentation](docs/)
+- [License](LICENSE)

ibm_mdm_mcp_server-1.0.9/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

ibm_mdm_mcp_server-1.0.9/MANIFEST.in

@@ -0,0 +1,40 @@
+# Copyright [2026] [IBM]
+# Licensed under the Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0)
+# See the LICENSE file in the project root for license information.
+
+# This file has been modified with the assistance of IBM Bob (AI Code Assistant)
+
+# Include documentation files
+include README.md
+include LICENSE
+include CHANGELOG.md
+include requirements.txt
+include pytest.ini
+
+# Include documentation directory
+recursive-include docs *.md
+recursive-include docs/pypi *
+
+# Include source files
+recursive-include src *.py
+include src/.env.example
+
+# Include tests
+recursive-include tests *.py
+
+# Exclude unnecessary files
+global-exclude __pycache__
+global-exclude *.py[co]
+global-exclude .DS_Store
+global-exclude *.so
+global-exclude *.dylib
+
+# Exclude development and build artifacts
+prune .venv
+prune venv
+prune build
+prune dist
+prune *.egg-info
+prune .pytest_cache
+prune htmlcov
+prune scratchpad