ApiLogicServer 14.5.4__py3-none-any.whl → 14.5.14__py3-none-any.whl

api_logic_server_cli/prototypes/basic_demo/customizations/logic/logic_discovery/mcp_client_executor_request.py

@@ -0,0 +1,320 @@
+""" 
+This simulates the MCP Client Executor, 
+which takes a natural language query and converts it into a tool context block:
+
+1. Discovers MCP servers (from config)
+2. Queries OpenAI's GPT-4 model to obtain the tool context based on a provided schema and a natural language query
+3. Processes the tool context (calls the indicated MCP (als) endpoints)
+
+Notes:
+* See: integration/mcp/README_mcp.md
+* python api_logic_server_run.py
+
+"""
+
+import json
+import os, sys
+from typing import Dict, List
+import openai
+import requests
+from logic_bank.exec_row_logic.logic_row import LogicRow
+from logic_bank.logic_bank import Rule
+from database import models
+from logic_bank.util import ConstraintException
+
+# Set your OpenAI API key
+openai.api_key = os.getenv("APILOGICSERVER_CHATGPT_APIKEY")
+
+server_url = os.getenv("APILOGICSERVER_URL", "http://localhost:5656/api")
+
+# debug settings
+test_type = 'orchestration'  # 'simple_get' or 'orchestration'
+create_tool_context_from_llm = True
+''' set to False to bypass LLM call and save 2-3 secs in testing '''
+use_test_schema = False
+''' True means bypass discovery, use hard-coded schedma file '''
+
+def discover_mcp_servers():
+    """ Discover the MCP servers by calling the /api/.well-known/mcp.json endpoint.
+    This function retrieves the list of available MCP servers and their capabilities.
+    """
+    global server_url, use_test_schema
+
+    # create schema_text (for prompt), by reading integration/mcp/mcp_schema.txt
+
+    # find the servers - read the mcp_server_discovery.json file
+    discovery_file_path = os.path.join(os.path.dirname(__file__), "../../integration/mcp/mcp_server_discovery.json")
+    try:
+        with open(discovery_file_path, "r") as discovery_file:
+            discovery_data = json.load(discovery_file)
+            print(f"\n1. Discovered MCP servers from config file: {discovery_file_path}:" + json.dumps(discovery_data, indent=4))
+    except FileNotFoundError:
+        print(f"Discovery file not found at {discovery_file_path}.")
+    except json.JSONDecodeError as e:
+        print(f"Error decoding JSON from {discovery_file_path}: {e}")
+    
+    for each_server in discovery_data["servers"]:
+        discovery_url = each_server["schema_url"]
+
+        # Call the discovery_url to get the MCP/API schema
+        try:
+            response = requests.get(discovery_url)
+            if response.status_code == 200:
+                api_schema = response.json()
+                print()
+                request_print = json.dumps(api_schema, indent=4)[0:400] + '\n... etc'  # limit for readability
+                print(f"\n\nAPI Schema from discovery schema_url: {discovery_url}:\n" + request_print)
+            else:
+                print(f"Failed to retrieve API schema from {discovery_url}: {response.status_code}")
+        except requests.RequestException as e:
+            print(f"Error calling OpenAPI URL: {e}")
+    return json.dumps(api_schema)
+
+
+def get_user_nl_query_and_training(query: str):
+    """ Get the natural language query from the user. 
+    Add training for the LLM to generate a tool context block.
+    
+    """
+
+    global test_type
+    # read file docs/mcp_learning/mcp.prompt
+    prompt_file_path = os.path.join(os.path.dirname(__file__), "../../docs/mcp_learning/mcp.prompt")
+    if os.path.exists(prompt_file_path):
+        with open(prompt_file_path, "r") as prompt_file:
+            training_prompt = prompt_file.read()
+            # print(f"\nLoaded training prompt from {prompt_file_path}:\n{training_prompt}")
+    else:
+        training_prompt = ""
+        print(f"Prompt file not found at {prompt_file_path}.")
+    return query + "\n\n" + training_prompt
+
+
+def query_llm_with_nl(schema_text, nl_query):
+    """ 
+    Query the LLM with a natural language query and schema text to generate a tool context block.
+
+    It handles both orchestration and simple GET requests.
+    """
+
+    global test_type, create_tool_context_from_llm
+
+    content = f"Natural language query:\n {nl_query}\nSchema:\n{schema_text}"
+    messages = [
+        {
+            "role": "system",
+            "content": "You are an API planner that converts natural language queries into MCP Tool Context blocks using JSON:API. Return only the tool context as JSON."
+        },
+        {
+            "role": "user",
+            "content": f"{content}"
+        }
+    ]
+
+    request_print = content[0:1200] + '\n... etc'  # limit for readability
+    print("\n\n2a. LLM request:\n", request_print)
+    # print("\n2b. NL Query:\n", nl_query)
+    # print("\n2c. schema_text: (truncated) \n")
+    # schema_print = json.dumps(json.loads(schema_text), indent=4)[:400]  # limit for readability
+    # print(schema_print)
+
+    if create_tool_context_from_llm:  # takes 2-3 seconds...
+      response = openai.chat.completions.create(
+          model="gpt-4",
+          messages=messages,
+          temperature=0.2
+      )
+
+      tool_context_str = response.choices[0].message.content
+      tool_context_str_no_cr = tool_context_str.replace("\n", '')  # convert single quotes to double quotes
+      try:
+          tool_context = json.loads(tool_context_str_no_cr)
+      except json.JSONDecodeError:
+          print("Failed to decode JSON from response:", tool_context_str)
+          return None
+
+    print("\n2d. generated tool context from LLM:\n", json.dumps(tool_context, indent=4))
+
+    if "resources" not in tool_context:
+        raise ConstraintException("GenAI Error - LLM response does not contain 'resources'.")
+    return tool_context
+
+
+def process_tool_context(tool_context):
+    """ Process the orchestration request by executing multiple tool context blocks.
+    This executes the tool context blocks against a live JSON:API server. 
+    It handles both GET and POST requests, and it can
+    orchestrate multiple requests based on the provided tool context.
+
+    Note the orchestration is processed by the client executor (here), not the server executor.
+
+    Research: 
+
+    1. How is this a "USB", since the request was specific about JSON:API?
+    2. How is it clear to loop through the tool_context[0] and call tool_context[1]?
+    """
+    global server_url
+
+    def get_query_param_filter(query_params):
+        """ return json:api filter
+
+        eg
+            curl -qg 'http://localhost:5656/api/Order?filter=[{"name":"date_shipped","op":"eq","val":null},{"name":"CreatedOn","op":"lt","val":"2023-07-14"}]'
+
+            curl -qg 'http://localhost:5656/api/Order?filter=[{"name":"date_shipped","op":"gt","val":"2023-07-14"}]'
+            curl -qg 'http://localhost:5656/api/Order?filter=[{"name":"date_shipped","op":"eq","val":null}]'
+            curl -qg 'http://localhost:5656/api/Customer?filter=[{"name":"credit_limit","op":"gt","val":"1000"}]'
+        
+        query_params might be simple:
+            "query_params": [ {"name": "credit_limit", "op": "gt", "val": "1000"} ]
+            ==> ?filter=[{"name":"credit_limit","op":"gt","val":"1000"}]
+
+        or a list:
+            "query_params": [
+                {
+                    "name": "date_shipped",
+                    "op": "eq",
+                    "val": None
+                },
+                {
+                    "name": "date_created",
+                    "op": "lt",
+                    "val": "2023-07-14"
+                }
+            ],
+
+        """
+
+        added_rows = 0
+
+        query_param_filter = ''
+        assert isinstance(query_params, list), "Query Params filter expected to be a list"
+        query_param_filter = 'filter=' + str(query_params)
+        # use urlencode to convert to JSON:API format...
+        # val urllib.parse.quote() or urllib.parse.urlencode()
+        # tool instructions... filtering, email etc "null"
+        query_param_filter = query_param_filter.replace("'", '"')  # convert single quotes to double quotes
+        query_param_filter = query_param_filter.replace("None", 'null')
+        query_param_filter = query_param_filter.replace('"null"', 'null')
+        # query_param_filter = query_param_filter.replace("date_created", 'CreatedOn')  # TODO - why this name?
+        return query_param_filter  # end get_query_param_filter
+
+    def move_fields(src: dict, dest: dict, context_data: dict):
+        """ Move fields from src to dest, replacing any variables with their values from context_data."""
+        for variable_name, value in src.items():
+            move_value = value
+            if move_value.startswith("{") and move_value.endswith("}"):  
+                # strip the braces, and get the name after the first dot, # eg: "{Order.customer_id}" ==> "customer_id"``
+                move_name = move_value[1:-1]  # strip the braces
+                if '.' in move_value:
+                    move_name = move_name.split('.', 1)[1]
+                move_value = context_data['attributes'][move_name]
+            dest[variable_name] = move_value
+        return dest
+
+    def print_get_response(query_param_filter, mcp_response):
+        """ Print the response from the GET request. """
+        print("\n3. MCP Server (als) GET filter(query_param_filter):\n", query_param_filter)
+        print("     GET Response:\n", mcp_response.text)
+        results : List[Dict] = mcp_response.json()['data']
+        # print results in a table format
+        if results:
+            # Get all unique keys from all result dicts
+            keys = set()
+            for row in results:
+                if isinstance(row, dict):
+                    keys.update(row.keys())
+            keys = list(keys)
+            # Print header
+            print("\n| " + " | ".join(keys) + " |")
+            print("|" + "|".join(["---"] * len(keys)) + "|")
+            # Print rows
+            for row in results:
+                print("| " + " | ".join(str(row.get(k, "")) for k in keys) + " |")
+        else:
+            print("No results found.")
+
+    assert isinstance(tool_context, (dict, list)), "Tool context expected to be a dictionary"
+    context_data = {}
+    added_rows = 0
+
+    for each_block in tool_context["resources"]:
+        if process_tool_context := True:
+            if each_block["method"] == "GET":
+                    query_param_filter = get_query_param_filter(each_block["query_params"])
+                    headers = {"Content-Type": "application/vnd.api+json"}
+                    if "headers" in each_block:
+                        headers.update(each_block["headers"])
+                    mcp_response = requests.get(
+                        url = each_block["base_url"] + each_block["path"],
+                        headers=headers,
+                        params=query_param_filter
+                    )
+                    context_data = mcp_response.json()['data']  # result rows...
+                    print_get_response(query_param_filter, mcp_response)
+            elif each_block["method"] in ["POST"]:
+                    for each_order in context_data:
+                        url = each_block["base_url"] + each_block["path"]
+                        json_update_data =  { 'data': {"type": each_block["path"][1:], 'attributes': {} } }  
+                        json_update_data_attributes = json_update_data["data"]["attributes"]
+                        move_fields( src= each_block["body"], dest=json_update_data_attributes, context_data=each_order) 
+                        # eg: POST http://localhost:5656/api/SysEmail {'data': {'type': 'SysEmail', 'attributes': {'customer_id': 5, 'message': {'to': '{{ order.customer_id }}', 'subject': 'Discount for your order', 'body': 'Dear customer, you have a discount for your recent order. Thank you for shopping with us.'}}}}
+                        headers = {"Content-Type": "application/vnd.api+json"}
+                        if "headers" in each_block:
+                            headers.update(each_block["headers"])
+                        mcp_response = requests.post(  
+                            url=url,
+                            headers=headers,
+                            json=json_update_data
+                        )
+                        added_rows += 1
+        pass
+    print("\n3. MCP Server (als) POST Response:\n", mcp_response.text)
+    if added_rows > 0:
+        print(f"...Added {added_rows} rows to the database; last row (only) shown above.")
+    return mcp_response 
+
+
+
+def declare_logic():
+    """
+        This illustrates the request pattern.
+
+        The request pattern is a common pattern in API Logic Server, 
+        where an insert triggers service invocation, such as sending email.
+        
+        The Email table includes the columns for the email (e,g, recipient, subject, message).
+        
+        Using a request object enables you to wrap the service call with logic, eg:
+        
+        * *email requirement: do not send mail if customer has opted out*  
+
+        See: https://apilogicserver.github.io/Docs/Integration-MCP/#3a-logic-request-pattern     
+    """
+
+
+    def mcp_client_executor(row: models.SysMcp, old_row: models.SysMcp, logic_row: LogicRow):
+        """ 
+
+        #als: create an MCP request
+
+        curl -X 'POST' 'http://localhost:5656/api/SysMcp/' -H 'accept: application/vnd.api+json' -H 'Content-Type: application/json' -d '{ "data": { "attributes": {"request": "List the orders date_shipped is null and CreatedOn before 2023-07-14, and send a discount email (subject: '\''Discount Offer'\'') to the customer for each one."}, "type": "SysMcp"}}'
+
+        Args:
+            row (Mcp): inserted MCP with prompt
+            old_row (Mcp): n/a
+            logic_row (LogicRow): bundles curr/old row, with ins/upd/dlt logic
+        """
+        schema_text = discover_mcp_servers()                    # see: 1-discovery-from-als
+
+        query_example = "List the orders date_shipped is null and CreatedOn before 2023-07-14, and send a discount email (subject: 'Discount Offer') to the customer for each one."
+        query = row.request
+        prompt = get_user_nl_query_and_training(query)
+
+        tool_context = query_llm_with_nl(schema_text, prompt)    # see: 2-tool-context-from-LLM   
+
+        mcp_response = process_tool_context(tool_context)       # see: 3-MCP-server response
+
+        print("\nTest complete.\n")
+
+    Rule.row_event(on_class=models.SysMcp, calling=mcp_client_executor)  # see above

api_logic_server_cli/prototypes/basic_demo/customizations/logic/logic_discovery/simple_constraints.py

@@ -0,0 +1,25 @@
+import datetime
+from decimal import Decimal
+from logic_bank.exec_row_logic.logic_row import LogicRow
+from logic_bank.extensions.rule_extensions import RuleExtension
+from logic_bank.logic_bank import Rule
+from database import models
+import api.system.opt_locking.opt_locking as opt_locking
+from security.system.authorization import Grant
+import logging
+from flask import jsonify
+
+app_logger = logging.getLogger(__name__)
+
+def declare_logic():
+    """
+        Simple constraints for error testing, e.g.:
+        
+        * Set a breakpoint on `as_condition`
+        * Observe the row values in the debugger
+    """
+
+    Rule.constraint(validate=models.Customer,
+        as_condition=lambda row: row.name != 'x',
+        error_msg="Customer name cannot be 'x'")
+

api_logic_server_cli/prototypes/basic_demo/customizations/ui/admin/admin.yaml

@@ -1,17 +1,12 @@
 about:
-  date: May 13, 2025 20:12:31
-  merged:
-    at: May 13, 2025 20:15:21
-    new_attributes: 'Customer.email Order.CreatedOn '
-    new_resources: 'Email '
-    new_tab_groups: 'Customer.EmailList '
+  date: May 26, 2025 06:57:17
   recent_changes: works with modified safrs-react-admin
   version: 0.0.0
 api_root: '{http_type}://{swagger_host}:{port}/{api}'
 authentication: '{system-default}'
 info:
   number_relationships: 4
-  number_tables: 5
+  number_tables: 6
 info_toggle_checked: true
 resources:
   Customer:
@@ -24,10 +19,10 @@ resources:
       type: DECIMAL
     - name: credit_limit
       type: DECIMAL
-    - name: id
     - name: email
     - name: email_opt_out
-      type: BOOLEAN
+      type: Boolean
+    - name: id
     tab_groups:
     - direction: tomany
       fks:
@@ -37,29 +32,10 @@ resources:
     - direction: tomany
       fks:
       - customer_id
-      name: EmailList
-      resource: Email
+      name: SysEmailList
+      resource: SysEmail
     type: Customer
     user_key: name
-  Email:
-    attributes:
-    - label: ' id*'
-      name: id
-      search: true
-      sort: true
-    - name: customer_id
-      required: true
-    - name: message
-    - name: CreatedOn
-      type: DATE
-    tab_groups:
-    - direction: toone
-      fks:
-      - customer_id
-      name: customer
-      resource: Customer
-    type: Email
-    user_key: id
   Item:
     attributes:
     - label: ' id*'
@@ -97,12 +73,12 @@ resources:
     - name: customer_id
       required: true
     - name: notes
+    - name: CreatedOn
+      type: DATE
     - name: amount_total
       type: DECIMAL
     - name: date_shipped
       type: DATE
-    - name: CreatedOn
-      type: DATE
     tab_groups:
     - direction: tomany
       fks:
@@ -133,6 +109,37 @@ resources:
       resource: Item
     type: Product
     user_key: name
+  SysEmail:
+    attributes:
+    - label: ' id*'
+      name: id
+      search: true
+      sort: true
+    - name: customer_id
+      required: true
+    - name: message
+    - name: subject
+    - name: CreatedOn
+      type: DATE
+    tab_groups:
+    - direction: toone
+      fks:
+      - customer_id
+      name: customer
+      resource: Customer
+    type: SysEmail
+    user_key: id
+  SysMcp:
+    attributes:
+    - label: ' id*'
+      name: id
+      search: true
+      sort: true
+    - name: request
+    - name: request_prompt
+    - name: completion
+    type: SysMcp
+    user_key: id
 settings:
   HomeJS: /admin-app/home.js
   max_list_columns: 8

api_logic_server_cli/prototypes/basic_demo/iteration/ui/admin/admin.yaml

@@ -1,17 +1,12 @@
 about:
-  date: May 13, 2025 20:12:31
-  merged:
-    at: May 13, 2025 20:15:21
-    new_attributes: 'Customer.email Order.CreatedOn '
-    new_resources: 'Email '
-    new_tab_groups: 'Customer.EmailList '
+  date: May 26, 2025 06:57:17
   recent_changes: works with modified safrs-react-admin
   version: 0.0.0
 api_root: '{http_type}://{swagger_host}:{port}/{api}'
 authentication: '{system-default}'
 info:
   number_relationships: 4
-  number_tables: 5
+  number_tables: 6
 info_toggle_checked: true
 resources:
   Customer:
@@ -24,14 +19,10 @@ resources:
       type: DECIMAL
     - name: credit_limit
       type: DECIMAL
-    - name: id
     - name: email
     - name: email_opt_out
-      type: BOOLEAN
-    description: Defines the Customer entity with a unique name, balance, and credit
-      limit.
-    info_list: Defines the Customer entity with a unique name, balance, and credit
-      limit.    
+      type: Boolean
+    - name: id
     tab_groups:
     - direction: tomany
       fks:
@@ -41,29 +32,10 @@ resources:
     - direction: tomany
       fks:
       - customer_id
-      name: EmailList
-      resource: Email
+      name: SysEmailList
+      resource: SysEmail
     type: Customer
     user_key: name
-  Email:
-    attributes:
-    - label: ' id*'
-      name: id
-      search: true
-      sort: true
-    - name: customer_id
-      required: true
-    - name: message
-    - name: CreatedOn
-      type: DATE
-    tab_groups:
-    - direction: toone
-      fks:
-      - customer_id
-      name: customer
-      resource: Customer
-    type: Email
-    user_key: id
   Item:
     attributes:
     - label: ' id*'
@@ -79,8 +51,6 @@ resources:
       type: DECIMAL
     - name: unit_price
       type: DECIMAL
-    description: Defines the Item entity with quantity, amounts, and unit price details.
-    info_list: Defines the Item entity with quantity, amounts, and unit price details.
     tab_groups:
     - direction: toone
       fks:
@@ -103,16 +73,12 @@ resources:
     - name: customer_id
       required: true
     - name: notes
+    - name: CreatedOn
+      type: DATE
     - name: amount_total
       type: DECIMAL
     - name: date_shipped
       type: DATE
-    - name: CreatedOn
-      type: DATE
-    description: Defines the Order entity which belongs to a customer. Includes notes
-      and amount total.
-    info_list: Defines the Order entity which belongs to a customer. Includes notes
-      and amount total.
     tab_groups:
     - direction: tomany
       fks:
@@ -137,8 +103,6 @@ resources:
     - name: carbon_neutral
       type: BOOLEAN
     - name: id
-    description: Defines the Product entity with a unique name and unit price.
-    info_list: Defines the Product entity with a unique name and unit price.
     tab_groups:
     - direction: tomany
       fks:
@@ -147,6 +111,37 @@ resources:
       resource: Item
     type: Product
     user_key: name
+  SysEmail:
+    attributes:
+    - label: ' id*'
+      name: id
+      search: true
+      sort: true
+    - name: customer_id
+      required: true
+    - name: message
+    - name: subject
+    - name: CreatedOn
+      type: DATE
+    tab_groups:
+    - direction: toone
+      fks:
+      - customer_id
+      name: customer
+      resource: Customer
+    type: SysEmail
+    user_key: id
+  SysMcp:
+    attributes:
+    - label: ' id*'
+      name: id
+      search: true
+      sort: true
+    - name: request
+    - name: request_prompt
+    - name: completion
+    type: SysMcp
+    user_key: id
 settings:
   HomeJS: /admin-app/home.js
   max_list_columns: 8

api_logic_server_cli/prototypes/manager/.vscode/launch.json

@@ -103,6 +103,27 @@
             "console": "internalConsole",
             "internalConsoleOptions": "openOnSessionStart"
         },
+        {
+            "name": "  - 1.5  GENAI - repaired-response=genai_demo.response_example",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "${workspaceFolder}/venv/lib/python3.12/site-packages/api_logic_server_cli/cli.py",
+            "redirectOutput": true,
+            "cwd": "${workspaceFolder}",
+            "env": {
+                "PYTHONPATH": "", 
+                "SECURITY_ENABLED": "False", 
+                "PYTHONHASHSEED": "0", 
+                "APILOGICSERVER_DEBUG": "False",
+                "OPT_LOCKING": "optional"},
+            "justMyCode": false,
+            "args": [ "genai", "--retries=-1"
+                , "--using=enai_demo.prompt"
+                , "--project-name=genai_demo"
+                , "--repaired-response=system/genai/examples/genai_demo/genai_demo.response_example"],
+            "console": "internalConsole",
+            "internalConsoleOptions": "openOnSessionStart"
+        },
         {
             "name": "ApiLogicServer Create",
             "type": "debugpy",

api_logic_server_cli/prototypes/manager/{README.md → READMEz.md}

@@ -1,7 +1,7 @@
 ---
-version info: 1.0 (01/11/2025)
+version info: 2.0 (05/24/2025)
 ---
-## Welcome to API Logic Server
+## Welcome to GenAI-Logic
 
 1. ***Instant microservices*** (APIs and Admin Apps) from a database or **GenAI prompt** -- 1 command
 
@@ -79,7 +79,7 @@ Created projects use standard Flask and SQLAlchemy; automation is provided by Lo
 als create --project-name=basic_demo --db-url=basic_demo
 ```
 
-<br>The self-demo provides:
+<br>The basic_demo project provides:
 1. A quick look at logic, security and integration
 2. Integration includes Kafka and MCP (**[Model Context Protocol](https://apilogicserver.github.io/Docs/Integration-MCP/)**)
 
@@ -102,7 +102,7 @@ Then, try your own databases [(db-url examples here)](https://apilogicserver.git
 
 <br>You can do this with or without signup:
 
-1. If you have signed up (see *To obtain a ChatGPT API Key*, below), this will create and open a project called `genai_demo` from `genai_demo.prompt` (available in left Explorer pane):
+1. If you have signed up (see *To obtain a ChatGPT API Key*, below), this will create a new database and project called `genai_demo`, and open the project.  It's created using `genai_demo.prompt`, visible in left Explorer pane:
 
 ```bash
 als genai --using=system/genai/examples/genai_demo/genai_demo.prompt --project-name=genai_demo