ApiLogicServer 15.0.0__py3-none-any.whl → 15.0.10__py3-none-any.whl

api_logic_server_cli/add_cust/add_cust.py

@@ -148,9 +148,15 @@ def add_basic_demo_customizations(project: Project, do_show_messages: bool = Tru
 
     if do_show_messages:
         log.info("\nExplore key customization files:")
-        log.info(f'..logic/declare_logic.py')
+        log.info('\033[94m\033[1m..logic/declare_logic.py\033[0m')
         log.info(f'..security/declare_security.py\n')
-        log.info(f'Explore MCP (Model Context Protocol): https://apilogicserver.github.io/Docs/Integration-MCP/\n')
+        # Make the message blue, bold, and add an attention-getting icon
+        log.info('\033[94m\033[1m🔷 Explore MCP (Model Context Protocol): https://apilogicserver.github.io/Docs/Integration-MCP/\033[0m\n')
+        log.info('.. restart the server')
+        log.info('python integration/mcp/mcp_client_executor.py mcp')
+        # log.info(".. Copy/paste this into your terminal (Mac/Linux):")
+        # log.info(".. 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\"}}'")
+        log.info('')
         log.info(f'Next Steps: activate security')
         log.info(f'..ApiLogicServer add-auth --db_url=auth')
         if project.is_tutorial == False:

api_logic_server_cli/api_logic_server.py

@@ -12,10 +12,10 @@ ApiLogicServer CLI: given a database url, create [and run] customizable ApiLogic
 Called from api_logic_server_cli.py, by instantiating the ProjectRun object.
 '''
 
-__version__ = "15.00.00"  # last public release: 15.00.00 (14.05.04)
+__version__ = "15.00.10"  # last public release: 15.00.10 (15.00.00)
 recent_changes = \
     f'\n\nRecent Changes:\n' +\
-    "\t05/28/2024 - 15.00.00: MCP \n"\
+    "\t06/08/2024 - 15.00.10: MCP, optional shortening of stacktrace lines, bugfix[92] \n"\
     "\t05/16/2024 - 14.05.00: safrs 3.1.7, running mcp preview \n"\
     "\t04/27/2024 - 14.04.00: Graphics preview, Vibe install fix, Improved IDE Chat Logic, MCP Exploration \n"\
     "\t03/30/2024 - 14.03.25: WebGenAI fixes for Kafka and Keycloak \n"\

api_logic_server_cli/api_logic_server_info.yaml

@@ -1,3 +1,3 @@
-last_created_date: May 28, 2025 12:08:45
-last_created_project_name: /Users/val/dev/ApiLogicServer/ApiLogicServer-dev/servers/basic_demo
-last_created_version: 14.05.16
+last_created_date: June 08, 2025 16:06:20
+last_created_project_name: samples/nw_sample_nocust
+last_created_version: 15.00.09

api_logic_server_cli/create_from_model/dbml.py

@@ -207,6 +207,7 @@ class DBMLCreator(object):
         '''        
         """
         
+        # copy mcp learning from manager (to enable user to extend)
         docs_path = Path(self.mod_gen.project_directory).joinpath('docs')
         docs_path.mkdir(parents=True, exist_ok=True)
         mcp_learning_src = genai_svcs.get_manager_path(use_env=True).joinpath('system/genai/mcp_learning')

api_logic_server_cli/genai/genai_svcs.py

@@ -152,8 +152,11 @@ def get_code_update_logic_file(rule_list: List[DotMap], logic_file_path: Path =
             project (Project): a Project object (unless creating a logic file)
             imports (set): the set of imported classes
         """        
-        insert_logic = "\n    # Logic from GenAI: (or, use your IDE w/ code completion)\n"
-        insert_logic += translated_logic
+        insert_logic = "\n    # Logic from GenAI: (or, use your IDE with code completion)\n"
+        insert_import = translated_logic
+        if 'import \n' in translated_logic:
+            insert_import = "    # no rules"
+        insert_logic += insert_import
         insert_logic += "\n    # End Logic from GenAI\n\n"
 
         insert_point = 'discover_logic()'  # default for als`

api_logic_server_cli/manager.py

@@ -19,6 +19,7 @@ def create_manager(clean: bool, open_with: str, api_logic_server_path: Path,
     1. .vscode, readme
     2. System folder (GenAI sample prompts / responses, others TBD)
     3. pre-created samples (optional)
+    4. readme (from docs: Sample-Basic-Tour.md)
 
     Example, from CLI in directory containing a `venv` (see https://apilogicserver.github.io/Docs/Manager/):
         als start

api_logic_server_cli/prototypes/base/api/api_discovery/mcp_discovery.py

@@ -1,9 +1,8 @@
 from flask import request, jsonify
-from flask import Flask, redirect, send_from_directory, send_file
 import logging
 import os
 import json
-import io
+from pathlib import Path
 
 import requests
 from config.config import Args  # circular import error if at top
@@ -23,36 +22,76 @@ def add_service(app, api, project_dir, swagger_host: str, PORT: str, method_deco
         return result  #  + '/api'
         
 
+    @app.before_request
+    def before_any_request():
+        # print(f"[DEBUG] Incoming request: {request.method} {request.url}")
+        if activate_openapi_logging := False:
+            if request.content_type == 'application/json' and request.method in ['POST', 'PUT', 'PATCH']:
+                # openapi: Incoming request: PATCH http://localhost:5656/api/Customer/1/ {'data': {'attributes': {'credit_limit': 5555}, 'type': 'Customer', 'id': '1'}}
+                # openapi: Incoming request: PATCH http://6f6f-2601-644-4900-d6f0-ecc9-6df3-8863-c5b2.ngrok-free.app/api/Customer/1 {'credit_limit': 5555}
+
+                app_logger.info(f"openapi: Incoming request: {request.method} {request.url} {str(request.json)}")
+            else:
+                app_logger.info(f"openapi: Incoming request: {request.method} {request.url}")
+            # app_logger.info(f"openapi: Incoming request headers: {request.headers}")
+
+            chatgpt_request_json = {
+                        "credit_limit": 25000,
+            }
+            standard_request_json = {
+                "data": {
+                    "type": "Customer",
+                    "id": "ALFKI",
+                    "attributes": {
+                        "name": "Alice",
+                        "credit_limit": 25000,
+                        "balance": 12345
+                    }
+                }
+            }
+            swagger_request_json = {
+                'data': {
+                    'attributes': {
+                        'credit_limit': 5555
+                        }, 
+                    'type': 'Customer', 
+                    'id': '1'
+                }
+            }
+        pass
+    
 
     @app.route('/.well-known/mcp.json', methods=['GET'])
     def mcp_discovery(path=None):
-        ''' called by mcp_client_executor for discovery, eg:
-        ```
-        {
-            "tool_type": "json-api",
-            "schema_version": "1.0",
-            "base_url": "https://crm.company.com",
-            "resources": [
-                {
-                "name": "Customer",
-                "path": "/Customer",
-                "methods": ["GET", "PATCH"],
-                "fields": ["id", "name", "balance", "credit_limit"],
-                "filterable": ["name", "credit_limit"],
-                "example": "List customers with credit over 5000"
-                }
-            ]
-        }
-        ```
-        test: curl -X GET "http://localhost:5656/.well-known/mcp.json"
+        ''' called by mcp_client_executor for discovery; read docs/mcp_learning/ for:
+        1. learning, including fan-out & response format, and email requests.
+        2. schema
+
+        see: https://apilogicserver.github.io/Docs/Integration-MCP/#1-discovery
+
+            test: curl -X GET "http://localhost:5656/.well-known/mcp.json"
         '''
         # return docs/mcp_schema.json
-        schema_path = os.path.join(project_dir, "docs/mcp_learning/mcp_schema.json")
+        mcp_learning_path = Path(project_dir + "/docs/mcp_learning")
         try:
+            schema_path = mcp_learning_path.joinpath('mcp_schema.json')
+            if not schema_path.exists():
+                return jsonify({"error": "System Error - /docs/mcp_learning/mcp_schema.json not found"}), 404
             with open(schema_path, "r") as schema_file:
                 schema = json.load(schema_file)
-                return jsonify(schema), 200
         except Exception as e:
             app_logger.error(f"Error loading MCP schema: {e}")
             return jsonify({"error": "MCP schema not found"}), 404
-        pass
+
+        try:
+            learnings_path = mcp_learning_path.joinpath('mcp.prompt')
+            if not learnings_path.exists():
+                return jsonify({"error": "System Error - /docs/mcp_learning/mcp,prompt not found"}), 404
+            with open(learnings_path, "r") as learnings_file:
+                learnings = learnings_file.read()
+        except Exception as e:
+            app_logger.error(f"Error loading MCP learnings: {e}")
+            return jsonify({"error": "MCP learnings not found"}), 404
+        schema['learning'] = learnings
+
+        return jsonify(schema), 200

api_logic_server_cli/prototypes/base/config/logging.yml

@@ -87,6 +87,11 @@ loggers:
         handlers: [console]
         propagate: no
 
+    integration.mcp:   
+        level: DEBUG
+        handlers: [console]
+        propagate: no
+
     integration.n8n:   
         level: DEBUG
         handlers: [console]

api_logic_server_cli/prototypes/base/config/server_setup.py

@@ -174,6 +174,75 @@ def get_args(flask_app: Flask) -> Args:
 #       LOGGING SETUP
 # ================================== 
 
+import site
+
+# Auto-detect venv site-packages path
+import logging
+import site
+
+venv_path = site.getsitepackages()[0]
+venv_alias = "$venv"
+app_path = str(Path(__file__).parent.parent)
+app_alias = ""
+max_len = 100  # max length of a line in stacktrace
+
+# Patch stacktrace formatters to replace venv path with alias
+def patch_stacktrace_formatters():
+    """
+    Patch only the formatException method of each formatter,
+    so only stacktraces are affected, not normal log lines.
+    """
+    import logging
+
+    def short_format_exception(self, exc_info):
+        result = logging.Formatter.formatException(self, exc_info)
+        lines = result.splitlines('\n')
+        line_num = 0
+        for each_line in lines:
+            follow_link = ""
+            if '1906' in each_line:
+                pass # good breakpoint
+            if venv_path in each_line:                
+                # get the string inside the double quotes
+                if '"' in each_line:
+                    follow_link = '\tFollow link: ' + each_line.split('"')[1] + ']'
+                # Replace the venv_path with venv_alias in the stacktrace line
+                each_line = each_line.replace('"' + venv_path, venv_alias)
+                each_line = each_line.replace('File ', '')  # replace project path with name
+                each_line = each_line.replace('", line ', ' @ ')
+                each_line = each_line.replace('^', '')
+                each_line = each_line.replace('\n', '')
+                lines[line_num] = each_line
+            elif app_path in each_line:
+                if '"' in each_line:
+                    follow_link = '\tFollow link: ' + each_line.split('"')[1] + ']'
+                each_line = each_line.replace('"' + app_path, app_alias)
+                each_line = each_line.replace('File ', '')
+                each_line = each_line.replace('", line ', ' @ ')
+                each_line = each_line.replace('\n', '')
+                lines[line_num] = each_line
+            elif '^^' in each_line:
+                lines[line_num] = ""
+            elif 'File "<string>", line' in each_line:
+                lines[line_num] = ""
+            # add spaces for 90 characters
+            if len(lines[line_num]) < max_len and lines[line_num] != "" and follow_link != "":
+                lines[line_num] = lines[line_num] + ' ' * (max_len - len(lines[line_num]))
+            lines[line_num] += follow_link
+            line_num += 1
+        result = ''.join(lines)
+        return result
+    
+    # Patch the formatException method of all formatters in the root logger
+
+    root_logger = logging.getLogger()
+    for handler in root_logger.handlers:
+        fmt = handler.formatter
+        if fmt and not hasattr(fmt, "_stacktrace_patched"):
+            fmt.formatException = short_format_exception.__get__(fmt)
+            fmt._stacktrace_patched = True
+
+
 def logging_setup() -> logging.Logger:
     """
     Setup Logging
@@ -187,6 +256,10 @@ def logging_setup() -> logging.Logger:
             f.close()
     logging.config.dictConfig(config)  # log levels: notset 0, debug 10, info 20, warn 30, error 40, critical 50
     app_logger = logging.getLogger("api_logic_server_app")
+
+    if do_truncate_venv_path := True:   # use False for standard Python logging in stacktrace
+        patch_stacktrace_formatters()
+
     debug_value = os.getenv('APILOGICPROJECT_DEBUG')
     if debug_value is not None:  # > export APILOGICPROJECT_DEBUG=True
         debug_value = debug_value.upper()

api_logic_server_cli/prototypes/base/integration/mcp/examples/mcp_discovery_response.json

@@ -0,0 +1,150 @@
+{
+  "http://localhost:5656/.well-known/mcp.json": {
+    "base_url": "http://localhost:5656/api",
+    "description": "API Logic Project: basic_demo",
+    "learning": [
+      "To issue one request per row from a prior step (fan-out), use the syntax:",
+      "",
+      "\"$<stepIndex>[*].<fieldName>\"",
+      "",
+      "For example, if step 0 returns orders, and you want to send a POST per customer:",
+      "",
+      "Before (incorrect):",
+      "    \"customer_id\": \"{customer_id}\"",
+      "",
+      "After (correct):",
+      "    \"customer_id\": \"$0[*].customer_id\"",
+      "",
+      "Only if 'email' is in the Natural language query, send email by issing a POST request to the SysEmail endpoint, setting the subject, message and customer_id in the body. DO NOT include a POST unless the word ‘email’ appears in the user query.",
+      "",
+      "Format response as mcp_responseFormat.",
+      "",
+      "<mcp_responseFormat>",
+      "class QueryParam(BaseModel):",
+      "    name: str  # attribute name",
+      "    op: str  # eq, lt, gt",
+      "    val: str",
+      "",
+      "class JsonValues(BaseModel):",
+      "    name: str  # name of attribute",
+      "    value: str # value of attribute",
+      "",
+      "class Resource(BaseModel):",
+      "    tool_type: str",
+      "    base_url: str",
+      "    path: str # specified use case or requirement name (use 'General' if missing)",
+      "    method: str # GET, PATCH, POST or DELETE",
+      "    body: json # data for PATCH or POST",
+      "    query_params: List(QueryParam) # filter for GET",
+      "",
+      "class MCPResult(BaseModel):  # must match system/genai/prompt_inserts/response_format.prompt",
+      "    schema_version: str",
+      "    resources : List[Resource] # list resources",
+      "",
+      "<mcp_responseFormat/>",
+      ""
+    ],
+    "resources": [
+      {
+        "fields": [
+          "id",
+          "name",
+          "balance",
+          "credit_limit",
+          "email",
+          "email_opt_out"
+        ],
+        "filterable": [
+          "id",
+          "name",
+          "balance",
+          "credit_limit",
+          "email",
+          "email_opt_out"
+        ],
+        "methods": [
+          "GET",
+          "PATCH",
+          "POST",
+          "DELETE"
+        ],
+        "name": "Customer",
+        "path": "/Customer"
+      },
+      {
+        "fields": [
+          "id",
+          "order_id",
+          "product_id",
+          "quantity",
+          "amount",
+          "unit_price"
+        ],
+        "filterable": [
+          "id",
+          "order_id",
+          "product_id",
+          "quantity",
+          "amount",
+          "unit_price"
+        ],
+        "methods": [
+          "GET",
+          "PATCH",
+          "POST",
+          "DELETE"
+        ],
+        "name": "Item",
+        "path": "/Item"
+      },
+      {
+        "fields": [
+          "id",
+          "notes",
+          "customer_id",
+          "CreatedOn",
+          "date_shipped",
+          "amount_total"
+        ],
+        "filterable": [
+          "id",
+          "notes",
+          "customer_id",
+          "CreatedOn",
+          "date_shipped",
+          "amount_total"
+        ],
+        "methods": [
+          "GET",
+          "PATCH",
+          "POST",
+          "DELETE"
+        ],
+        "name": "Order",
+        "path": "/Order"
+      },
+      {
+        "fields": [
+          "id",
+          "name",
+          "unit_price"
+        ],
+        "filterable": [
+          "id",
+          "name",
+          "unit_price"
+        ],
+        "methods": [
+          "GET",
+          "PATCH",
+          "POST",
+          "DELETE"
+        ],
+        "name": "Product",
+        "path": "/Product"
+      }
+    ],
+    "schema_version": "1.0",
+    "tool_type": "json-api"
+  }
+}

api_logic_server_cli/prototypes/base/integration/mcp/examples/mcp_request.prompt

@@ -0,0 +1,46 @@
+Natural language query:
+ 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.
+
+Learnings_and_Schema:
+{"base_url": "http://localhost:5656/api",
+"description": "API Logic Project: basic_demo", 
+"learning": "To issue one request per row from a prior step (fan-out), use the syntax:
+
+"$<stepIndex>[*].<fieldName>"
+
+For example, if step 0 returns orders, and you want to send a POST per customer:
+
+Before (incorrect):
+    "customer_id": "{customer_id}"
+
+After (correct):
+    "customer_id": "$0[*].customer_id"
+    
+Only if 'email' is in the Natural language query, send email by issing a POST request to the SysEmail endpoint, setting the subject, message and customer_id in the body.   DO NOT include a POST unless the word u2018emailu2019 appears in the user query.
+
+Format response as mcp_responseFormat.
+
+<mcp_responseFormat>
+class QueryParam(BaseModel):
+    name: str  # attribute name
+    op: str  # eq, lt, gt
+    val: str
+
+class JsonValues(BaseMopdel):
+    name: str  # name of attribute
+    value: str # value of attribute
+
+class Resource(BaseModel):
+    tool_type: str
+    base_url: str
+    path: str # specified use case or requirement name (use 'General' if missing)
+    method: str # GET, PATCH, POST or DELETE
+    body: json # data for PATCH or POST
+    query_params: List(QueryParam) # filter for GET
+
+class MCPResult(BaseModel):  # must match system/genai/prompt_inserts/response_format.prompt
+    schema_version: str
+    resources : List[Resource] # list resources
+
+<mcp_responseFormat/>
+", "resources": [{"fields": ["id", "name", "balance", "credit_limit", "email", "email_opt_out"], "filterable": ["id", "name", "balance", "credit_limit", "email", "email_opt_out"], "methods": ["GET", "PATCH", "POST", "DELETE"], "name": "Customer", "path": "/Customer"}, {"fields": ["id", "order_id", "product_id", "quantity", "amount", "unit_price"], "filterable": ["id", "order_id", "product_id", "quantity", "amount", "unit_price"], "methods": ["GET", "PATCH", "POST", "DELETE"], "name": "Item", "path": "/Item"}, {"fields": ["id", "notes", "customer_id", "CreatedOn", "date_shipped", "amount_total"], "filterable": ["id", "notes", "customer_id", "CreatedOn", "date_shipped", "amount_total"], "methods": ["GET", "PATCH", "POST", "DELETE"], "name": "Order", "path": "/Order"}, {"fields": ["id", "name", "unit_price"], "filterable": ["id", "name", "unit_price"], "methods": ["GET", "PATCH", "POST", "DELETE"], "name": "Product", "path": "/Product"}], "schema_version": "1.0", "tool_type": "json-api"}

api_logic_server_cli/prototypes/base/integration/mcp/examples/mcp_tool_context_response.json

@@ -0,0 +1,34 @@
+{
+    "schema_version": "1.0",
+    "resources": [
+        {
+            "tool_type": "json-api",
+            "base_url": "http://localhost:5656/api",
+            "path": "/Order",
+            "method": "GET",
+            "query_params": [
+                {
+                    "name": "date_shipped",
+                    "op": "eq",
+                    "val": "null"
+                },
+                {
+                    "name": "CreatedOn",
+                    "op": "lt",
+                    "val": "2023-07-14"
+                }
+            ]
+        },
+        {
+            "tool_type": "json-api",
+            "base_url": "http://localhost:5656/api",
+            "path": "/SysEmail",
+            "method": "POST",
+            "body": {
+                "subject": "Discount Offer",
+                "message": "Dear customer, we are offering a discount on your next purchase. Please check your account for more details.",
+                "customer_id": "$0[*].customer_id"
+            }
+        }
+    ]
+}

api_logic_server_cli/prototypes/base/integration/mcp/examples/mcp_tool_context_response_get.json

@@ -0,0 +1,18 @@
+{
+    "schema_version": "1.0",
+    "resources": [
+        {
+            "tool_type": "json-api",
+            "base_url": "http://localhost:5656/api",
+            "path": "/Customer",
+            "method": "GET",
+            "query_params": [
+                {
+                    "name": "credit_limit",
+                    "op": "gt",
+                    "val": "1000"
+                }
+            ]
+        }
+    ]
+}