docs: update README and dpc_restapi_summary with new metadata and remove outdated sections

.github/workflows/hf-sync.yaml

@@ -0,0 +1,28 @@
+name: Hugging Face Space Sync
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  sync-to-hub:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          lfs: true
+
+      - name: Push to HF Space
+        env:
+          HF_TOKEN: ${{ secrets.HF_TOKEN }}
+          HF_ORGANIZATION: ${{ vars.HF_ORGANIZATION }}
+          HF_SPACE: ${{ vars.HF_SPACE }}
+        run: |
+          git config --global user.email "actions@github.com"
+          git config --global user.name "GitHub Actions"
+          git remote add hf "https://api:$HF_TOKEN@huggingface.co/spaces/$HF_ORGANIZATION/$HF_SPACE"
+          git fetch hf
+          git checkout main
+          git push hf main --force

Dockerfile

@@ -0,0 +1,32 @@
+FROM ghcr.io/astral-sh/uv:python3.13-bookworm-slim
+
+RUN useradd -m -u 1000 chameleon
+
+USER chameleon
+
+# Enable bytecode compilation
+ENV UV_COMPILE_BYTECODE=1
+
+ENV PATH="/home/chameleon/.local/bin:$PATH"
+
+WORKDIR /app
+
+COPY --chown=chameleon pyproject.toml uv.lock ./
+
+RUN uv sync --no-dev
+
+COPY --chown=chameleon . /app
+
+# Reset the entrypoint, don't invoke `uv`
+ENTRYPOINT []
+
+ENV PORT=8000
+ENV FASTMCP_SERVER_HOST=0.0.0.0
+ENV FASTMCP_SERVER_PORT=8000
+ENV FASTMCP_SERVER_DEBUG=false
+
+# Expose the port
+EXPOSE 8000
+
+# Start command
+CMD ["uv", "run", "app.py"]

README.md

@@ -1,3 +1,13 @@
+---
+title: DpcMcpClient
+emoji: 🤯
+colorFrom: pink
+colorTo: yellow
+sdk: docker
+pinned: false
+short_description: MCP-Client Test for DNext Product Catalog MCPServer
+---
+
 # DPC MCP Client
 **Desinged to test the DNext Product Catalog REST API MCP Server.**
 

resources/dpc_restapi_summary.txt

@@ -1,34 +1,10 @@
 ====================================================
-**API_DESCRIPTION_BEGIN** section is provided below.
+**API_DESCRIPTION_BEGIN**
 
 **Description:** Dnext Product Catalog API, which is compliant with the TMF620 Product Catalog Management standard.
 This API allows users to manage key catalog elements such as product offerings, specifications, characteristics, and pricing. 
 It meets TMF620 minimum requirements while incorporating Dnext-specific fields or validations.
 
-**API Base URL:**
-`https://learning.test.orbitant.dev/api/productCatalogManagement/v4`
-
-**Allowed Constant Enum Values**: Use these valid values for specific fields when constructing tool inputs.
-* **General Constant Enum Values:**
-    - lifecycleStatus: "In study", "In design", "In test", "Active", "Launched", "Retired", "Obsolete", "Rejected", "None"
-    - valueType: "string", "number", "date", "true/false", "integer", "time", "macAddress"
-    - unitOfMeasure: "Second", "Minute", "Hour", "Day", "Week", "Month", "Year", "M", "Mm", "Cm", "Km", "Kg", "Pound", "Bps", "Mbps", "Gbps", "Question", "Byte", "Mb", "Gb", "Tb", "None", "Address", "Color", "Duration", "Joule", "Number", "Phone Number", "Size", "Currency"
-    - characteristicType: "Simple Value", "Range", "Choice"
-    - rangeInterval: "Open", "Closed", "Closed Bottom", "Closed Top"
-    - relationshipType: "aggregation", "migration", "substitution", "dependency", "exclusivity"
-
-* **ProductSpecification Constant Enum Values:**
-    - operationType: "add", "delete", "modify", "modify.Migration", "modify.Relocation", "modify.Takeover", "statusChange", "statusChange.Resume", "statusChange.Suspend"
-    - relation: "reliesOn", "uses"
-
-* **ProductOffering Constant Enum Values:**
-    - operationType: same as ProductSpecification
-    - relation: "reliesOn"
-
-* **ProductOfferingPrice Constant Enum Values:**
-    - priceType: "One time charge", "Data tariff charge", "Simple usage charge", "Recurring charge", "Per line charge", "Parametric charge", "Per contract charge", "Voice tariff charge", "Simple usage discount", "Recurring discount", "Voice tariff discount", "One time discount", "One time allowance", "Recurring allowance", "Weekend allowance", "Weekend voice allowance", "Weekend data allowance", "Data commitment", "Threshold commitment", "Usage commitment", "Penalty", "Deposit", "Cost", "Upfront payment"
-    - Money.unit: "ALL", "AUD", "CHF", "GBP", "EUR", "USD", "JPY", "CAD", "CNY", "HKD", "NZD", "TRY"
-
 **Core API Entities and Their Attributes:**
 **1. ProductCatalog**
 * **Description:** The central organizing entity for product-related data. It groups `ProductOffering`s and `Category` objects.
@@ -39,10 +15,8 @@ It meets TMF620 minimum requirements while incorporating Dnext-specific fields o
     * `description` (string): Optional. Description of this catalog.
     * `lifecycleStatus` (string): Optional. Used to indicate the current lifecycle status (e.g., "Active", "Retired", "Draft").
     * `version` (string): Optional. Version of the catalog.
-    * `validFor` (`TimePeriod` object): Optional. The period for which the catalog is valid.
     * `category` (array of `CategoryRef`): Optional. List of root categories contained in this catalog.
-    * `relatedParty` (array of `RelatedParty`): Optional. List of parties involved in this catalog.
-    * `@baseType`, `@schemaLocation`, `@type`: Optional meta-attributes for extension.
+
 
 **2. Category**
 * **Description:** Used for logically grouping product offerings. Categories can have a hierarchical structure (sub-categories).
@@ -54,12 +28,10 @@ It meets TMF620 minimum requirements while incorporating Dnext-specific fields o
     * `isRoot` (boolean): Optional. Indicates if this is a root category (default: `false`).
     * `lifecycleStatus` (string): Optional. Used to indicate the current lifecycle status.
     * `version` (string): Optional. Version of the category.
-    * `validFor` (`TimePeriod` object): Optional. The period for which the category is valid.
     * `parent` (`CategoryRef` object): Optional. Reference to the parent category if this is a sub-category.
     * `productCatalog` (array of `ProductCatalogRef`): Optional. References to the catalogs this category belongs to.
     * `productOffering` (array of `ProductOfferingRef`): Optional. References to product offerings associated with this category.
-    * `relatedParty` (array of `RelatedParty`): Optional. Parties involved in this category.
-    * `@baseType`, `@schemaLocation`, `@type`: Optional meta-attributes.
+
 
 **3. ProductCharacteristic**
 * **Description:** Represents a characteristic (attribute) of a product or product specification.
@@ -75,9 +47,7 @@ It meets TMF620 minimum requirements while incorporating Dnext-specific fields o
     * `maxCardinality` (integer): Optional. Max instances.
     * `minCardinality` (integer): Optional. Min instances.
     * `regex` (string): Optional. Regex to validate the value.
-    * `validFor` (`TimePeriod` object): Optional. Period of validity.
     * `productCharValue` (array of `ProductCharacteristicValue`): Optional. List of possible values.
-    * `@baseType`, `@schemaLocation`, `@type`: Optional meta-attributes.
 
 **4. ProductSpecification**
 * **Description:** Defines the technical details and attributes of a product or service.
@@ -92,15 +62,12 @@ It meets TMF620 minimum requirements while incorporating Dnext-specific fields o
     * `name` (string): Optional. Name of the specification.
     * `productNumber` (string): Optional. Product number.
     * `version` (string): Optional. Version.
-    * `validFor` (`TimePeriod` object): Optional. Period of validity.
     * `productSpecCharacteristic` (array of `ProductCharacteristic`): Optional. List of characteristics for this specification.
     * `serviceSpecification` (array of `ServiceSpecificationRef`): Optional. References to related service specifications.
     * `resourceSpecification` (array of `ResourceSpecificationRef`): Optional. References to related resource specifications.
     * `productSpecificationRelationship` (array of `ProductSpecificationRelationship`): Optional. Relationships with other specs.
-    * `attachment` (array of `AttachmentRefOrValue`): Optional. Related attachments.
-    * `relatedParty` (array of `RelatedParty`): Optional. Involved parties.
     * `targetProductSchema` (`TargetProductSchema` object): Optional. Schema reference.
-    * `@baseType`, `@schemaLocation`, `@type`: Optional meta-attributes.
+
 
 **5. ProductOfferingPrice**
 * **Description:** Details the pricing information for a `ProductOffering`.
@@ -110,7 +77,6 @@ It meets TMF620 minimum requirements while incorporating Dnext-specific fields o
     * `name` (string): **Mandatory**. Name of the price (e.g., "Monthly Fee", "One-Time Setup").
     * `description` (string): Optional. Description of the price.
     * `priceType` (string): **Mandatory**. Type of price (e.g., "recurring", "one time", "usage").
-    * `validFor` (`TimePeriod` object): Optional. Period of validity for the price.
     * `price` (`Money` object): **Mandatory**. The monetary value.
         * `price.value` (number): **Mandatory**. Numeric price value.
         * `price.unit` (string): **Mandatory**. Currency unit (e.g., "USD", "TRY").
@@ -125,8 +91,6 @@ It meets TMF620 minimum requirements while incorporating Dnext-specific fields o
     * `productOfferingPriceRelationship` (array of `ProductOfferingPriceRelationship`): Optional. Relationships with other prices.
     * `popRelationship` (array of `ProductOfferingPriceRelationship`): Optional. Alias for `productOfferingPriceRelationship`.
     * `constraint` (array of `ConstraintRef`): Optional. Constraints.
-    * `pricingLogicAlgorithm` (array of `PricingLogicAlgorithmRef`): Optional. Pricing algorithms.
-    * `@baseType`, `@schemaLocation`, `@type`: Optional meta-attributes.
 
 **6. ProductOffering**
 * **Description:** Represents a product or service offered to customers, linking specifications, pricing, and catalog organization.
@@ -140,192 +104,23 @@ It meets TMF620 minimum requirements while incorporating Dnext-specific fields o
     * `isBundle` (boolean): Optional. True if a bundle (default: false).
     * `isSellable` (boolean): Optional. True if sellable.
     * `version` (string): Optional. Version.
-    * `validFor` (`TimePeriod` object): Optional. Period of validity.
     * `category` (array of `CategoryRef`): References to categories this offering belongs to.
     * `productSpecification` (`ProductSpecificationRef` object): **Mandatory**. Reference to the underlying product specification.
     * `productOfferingPrice` (array of `ProductOfferingPriceRef`): Optional. References to associated prices.
     * `channel` (array of `ChannelRef`): Optional. Channels.
     * `place` (array of `PlaceRef`): Optional. Places.
-    * `agreement` (array of `AgreementRef`): Optional. Agreements.
     * `bundledProductOffering` (array of `BundledProductOffering`): Optional. If `isBundle` is true, lists contained offerings.
     * `resourceCandidate` (`ResourceCandidateRef` object): Optional. Resource candidate.
     * `serviceCandidate` (`ServiceCandidateRef` object): Optional. Service candidate.
     * `prodSpecCharValueUse` (array of `ProdSpecCharValueUse`): Optional. Defines char usage.
-    * `attachment` (array of `AttachmentRefOrValue`): Optional. Attachments.
-    * `relatedParty` (array of `RelatedParty`): Optional. Involved parties.
-    * `@baseType`, `@schemaLocation`, `@type`: Optional meta-attributes.
 
+=============================================================
 **Common Referenced Objects:**
-* **`TimePeriod`:** `{ "startDateTime": "string (date-time)", "endDateTime": "string (date-time)" }`
 * **`Money`:** `{ "value": "number", "unit": "string" }`
 * **`Quantity`:** `{ "amount": "number", "unit": "string" }`
 * **Reference Objects (`ProductCatalogRef`, `CategoryRef`, `ProductSpecificationRef`, `ProductOfferingPriceRef`, etc.):**
     * Typically contain `id` (string), `href` (string), `name` (string), and `@referredType` (string).
     * Example: `{"id": "some-id", "href": "path/to/resource/some-id", "name": "Resource Name", "@referredType": "ProductCatalog"}`
-* **`RelatedParty`:** `{ "id": "string", "href": "string", "name": "string", "role": "string", ...}`
-
-**Creating an Offer Process Documentation (Sequential Steps with Payloads):**
-To create a complete product offer in the system, you need to follow these sequential steps, making a POST request for each. Note that the IDs generated in previous steps are often used as references in subsequent steps.
-
-**Step 1: Create a Product Characteristic**
-* **Description:** Defines a unique attribute of a product, like speed or storage.
-* **Request URL:** `POST https://learning.test.orbitant.dev/api/productCatalogManagement/v4/productCharacteristic`
-* **Example Payload:**
-    ```json
-    {
-        "characteristicType": "Simple Value",
-        "configurable": false,
-        "extensible": false,
-        "isUnique": false,
-        "isVisible": false,
-        "isModifiable": false,
-        "mandatory": false,
-        "minCardinality": 0,
-        "maxCardinality": 1,
-        "name": "testSaturn",
-        "productCharacteristicValue": [
-            {
-                "isDefault": false,
-                "unitOfMeasure": "MBPS",
-                "value": "1000",
-                "valueType": "string"
-            }
-        ],
-        "valueType": "string"
-    }
-    ```
-    * **Explanation:** This payload creates a characteristic named 'testSaturn' with a value of '1000 MBPS', defining its behavior (e.g., not configurable, not mandatory). You would typically obtain the `id` from the response of this call for use in subsequent steps.
-
-**Step 2: Create a Product Offering Price**
-* **Description:** Defines the pricing structure for a product, including its value, type, and unit of measure.
-* **Request URL:** `POST https://learning.test.orbitant.dev/api/productCatalogManagement/v4/productOfferingPrice`
-* **Example Payload:**
-    ```json
-    {
-        "name": "testSaturnPrice",
-        "version": "0",
-        "priceType": "One time charge",
-        "unitOfMeasure": {
-            "units": "Day",
-            "amount": 1
-        },
-        "recurringChargePeriodType": "monthly",
-        "recurringChargePeriodLength": 0,
-        "isBundle": false,
-        "lifecycleStatus": "In study",
-        "price": {
-            "value": 100,
-            "unit": "USD"
-        },
-        "percentage": 0
-    }
-    ```
-    * **Explanation:** This payload defines a one-time price of 100 USD for a product offering. It specifies the price type, currency, and any recurring charge details. You would typically obtain the `id` from the response of this call.
-
-**Step 3: Create a Product Specification**
-* **Description:** Ties product characteristics and their values together to define the technical details of a product.
-* **Request URL:** `POST https://learning.test.orbitant.dev/api/productCatalogManagement/v4/productSpecification`
-* **Example Payload:**
-    ```json
-    {
-        "name": "testSaturnSpec",
-        "isBundle": false,
-        "lifecycleStatus": "In study",
-        "version": "0",
-        "productSpecCharacteristic": [
-            {
-                "id": "GENERATED_PRODUCT_CHARACTERISTIC_ID_FROM_STEP1",
-                "name": "testSaturn",
-                "characteristicType": "Simple Value",
-                "valueType": "string",
-                "configurable": false,
-                "isVisible": false,
-                "mandatory": false,
-                "extensible": false,
-                "minCardinality": 0,
-                "maxCardinality": 1,
-                "isUnique": false,
-                "productSpecCharacteristicValue": [
-                    {
-                        "valueType": "string",
-                        "value": "1000",
-                        "unitOfMeasure": "MBPS",
-                        "isDefault": false
-                    }
-                ],
-                "@type": "ProductCharacteristic",
-                "@baseType": "ProductCharacteristic"
-            }
-        ]
-    }
-    ```
-    * **Explanation:** This payload creates a product specification. It includes the `id` of the `ProductCharacteristic` created in Step 1, associating that characteristic with this specification. You would typically obtain the `id` from the response of this call.
-
-**Step 4: Create a Product Offering**
-* **Description:** Combines the product specification and pricing to form a complete, sellable offer.
-* **Request URL:** `POST https://learning.test.orbitant.dev/api/productCatalogManagement/v4/productOffering`
-* **Example Payload:**
-    ```json
-    {
-        "name": "testSaturnOffer",
-        "isBundle": false,
-        "lastUpdate": "2025-05-28T11:57:27.670Z",
-        "lifecycleStatus": "In study",
-        "version": "0",
-        "isSellable": false,
-        "productSpecification": {
-            "id": "GENERATED_PRODUCT_SPECIFICATION_ID_FROM_STEP3",
-            "href": "/api/productCatalogManagement/v4/productSpecification/GENERATED_PRODUCT_SPECIFICATION_ID_FROM_STEP3:(version=0)",
-            "name": "testSaturnSpec",
-            "version": "0"
-        },
-        "productOfferingPrice": [
-            {
-                "id": "GENERATED_PRODUCT_OFFERING_PRICE_ID_FROM_STEP2",
-                "href": "/api/productCatalogManagement/v4/productOfferingPrice/GENERATED_PRODUCT_OFFERING_PRICE_ID_FROM_STEP2:(version=0)",
-                "name": "testSaturnPrice",
-                "version": "0",
-                "@type": "ProductOfferingPrice",
-                "@referredType": "Product Offering Price"
-            }
-        ],
-        "prodSpecCharValueUse": [
-            {
-                "productSpecCharacteristicValue": [
-                    {
-                        "isDefault": false,
-                        "unitOfMeasure": "MBPS",
-                        "value": "1000",
-                        "valueType": "string"
-                    }
-                ],
-                "name": "testSaturn",
-                "characteristicType": "Simple Value",
-                "valueType": "string",
-                "minCardinality": 0,
-                "maxCardinality": 1,
-                "productSpecification": {
-                    "id": "GENERATED_PRODUCT_SPECIFICATION_ID_FROM_STEP3",
-                    "href": "/api/productCatalogManagement/v4/productSpecification/GENERATED_PRODUCT_SPECIFICATION_ID_FROM_STEP3:(version=0)",
-                    "name": "testSaturnSpec",
-                    "version": "0"
-                },
-                "configurable": false,
-                "isVisible": false,
-                "mandatory": false
-            }
-        ],
-        "category": [
-             // MANDATORY: Add a CategoryRef here (e.g., after creating a category via /category endpoint)
-             // Example: {"id": "category-id", "href": "/api/productCatalogManagement/v4/category/category-id", "name": "Category Name", "@referredType": "Category"}
-        ],
-        "productCatalog": [
-            // MANDATORY: Add a ProductCatalogRef here (e.g., after creating a catalog via /productCatalog endpoint)
-            // Example: {"id": "catalog-id", "href": "/api/productCatalogManagement/v4/productCatalog/catalog-id", "name": "Catalog Name", "@referredType": "ProductCatalog"}
-        ]
-    }
-    ```
-    * **Explanation:** This payload defines the complete `ProductOffering`. It references the `ProductSpecification` (from Step 3) and `ProductOfferingPrice` (from Step 2) using their generated IDs. It also re-iterates the product characteristic details for clarity within the offer. **Crucially, it requires `category` and `productCatalog` references which would need to be created via their respective endpoints first, if not already existing.**
 
 **API_DESCRIPTION_END**
 ====================================================