biblemate 0.0.21__py3-none-any.whl → 0.0.23__py3-none-any.whl

biblemate/README.md

@@ -61,21 +61,63 @@ How to swap?
 * Enter `.chat` in BibleMate AI prompt to enable chat mode and disable agent mode.
 * Enter `.agent` in BibleMate AI prompt to enable agent mode and disable chat mode.
 
-## Specify Toos(s) for a Particular Task
+## Manual Tool Selection
 
+In some cases, you may want to specify a particular tool for a simple task, rather than having a tool automatically selected in the fully automatic `agent mode`.
 
+You can specify a single tool by prefixing a tool name with `@` at the beginning of your prompt. For example,
 
-## Action Menu
+```
+@retrieve_bible_cross_references Deut 6:4; John 3:16
+```
+
+Watch this video: https://youtu.be/50m1KRj6uhs
+
+## Custom Master Plan with Multiple Tools
 
-*(Coming soon)*
+In some cases, you may want to specify a `custom plan` with multiple tools specified for different steps for a complex task, rather than having a `master plan` automatically generated in fully automatic agent mode.
 
-## Keyboard Shortcut
+You can use a custom 'Master Plan' of your own, instead of one generated by BibleMate AI. To do this, start your BibleMate AI prompt with '@@' followed by your own master plan for a Bible study. For example,
 
-*(Coming soon)*
+```
+@@ Analyze John 3:16 with the following steps: 
+1. Call tool 'retrieve_english_bible_verses' for Bible text, 
+2. Call tool 'retrieve_bible_cross_references' for Bible cross-references, 
+3. Call tool 'interpret_new_testament_verse' for interpretation, and 
+4. Call tool 'write_bible_theology' to explain its theology.
+```
 
-## Customization
+Watch this video: https://youtu.be/Lejq0sAx030
+
+The '@@' trick works even when you are using 'chat' mode with 'agent' mode disabled.
+
+## Action Menu
 
-*(Coming soon)*
+There is a set of predefined entries, that starts with a dot sign `.`:
+
+- `.new` - new conversation
+- `.quit` - quit
+- `.backend` - change backend
+- `.chat` - enable chat mode
+- `.agent` - enable agent mode
+- `.tools` - list available tools
+- `.backup` - backup conversation
+- `.open` - open a file or directory, e.g. `.open /home/user/report.html`
+
+## Keyboard Shortcuts
+
+The following key bindings are supported in BibleMate AI prompt field:
+
+- `Ctrl+N` new conversation
+- `Ctrl+Q` quit
+- `Ctrl+C` copy selected prompt text
+- `Ctrl+V` paste text in a prompt
+- `Ctrl+I` or `TAB` new line
+- `Ctrl+Z` clear prompt text
+- `Esc+a` jump to the beginning of a prompt
+- `Esc+z` jump to the end of a prompt
+- `Esc+b` or `HOME` jump to the beginning of a line in a prompt
+- `Esc+e` or `END` jump to the end of a line in a prompt
 
 ## License
 

biblemate/bible_study_mcp.py

@@ -1,5 +1,6 @@
 import logging
 from fastmcp import FastMCP
+from fastmcp.prompts.prompt import PromptMessage, TextContent
 from agentmake import agentmake
 from biblemate import AGENTMAKE_CONFIG
 
@@ -347,4 +348,22 @@ def write_bible_sermon(request:str) -> str:
     messages = agentmake(request, **{'instruction': 'bible/sermon', 'system': 'auto'}, **AGENTMAKE_CONFIG)
     return getResponse(messages)
 
+@mcp.prompt
+def simple_bible_study(request:str) -> PromptMessage:
+    """Perform a simple bible study task; bible reference(s) must be given"""
+    global PromptMessage, TextContent
+    prompt_text = f"""You are a bible study agent. You check the user request, under the `User Request` section, and resolve it with the following steps in order:
+1. Call tool 'retrieve_english_bible_verses' for Bible text, 
+2. Call tool 'retrieve_bible_cross_references' for Bible cross-references, 
+3. Call tool 'study_old_testament_themes' for study old testament themes or 'study_new_testament_themes' for study old testament themes, and 
+4. Call tool 'write_bible_theology' to explain its theology.
+
+# User Request
+
+---
+{request}
+---
+"""
+    return PromptMessage(role="user", content=TextContent(type="text", text=prompt_text))
+
 mcp.run(show_banner=False)

biblemate/main.py

@@ -39,6 +39,7 @@ async def main_async():
         tools_raw = await client.list_tools()
         #print(tools_raw)
         tools = {t.name: t.description for t in tools_raw}
+        tools = dict(sorted(tools.items()))
         tools_schema = {}
         for t in tools_raw:
             schema = {
@@ -69,6 +70,7 @@ Get a static text-based response directly from a text-based AI model without usi
         prompts_raw = await client.list_prompts()
         #print("# Prompts\n\n", prompts_raw, "\n\n")
         prompts = {p.name: p.description for p in prompts_raw}
+        prompts = dict(sorted(prompts.items()))
         prompt_list = [f"/{p}" for p in prompts.keys()]
         prompt_pattern = "|".join(prompt_list)
         prompt_pattern = f"""^({prompt_pattern}) """
@@ -176,7 +178,7 @@ Get a static text-based response directly from a text-based AI model without usi
                 ".agent": "enable agent mode",
                 ".tools": "list available tools",
                 #".resources": "list available resources",
-                #".prompts": "list available prompts",
+                ".prompts": "list available prompts",
                 ".backup": "backup conversation",
                 ".open": "open a file or directory",
             }
@@ -202,6 +204,11 @@ Get a static text-based response directly from a text-based AI model without usi
                     tools_descriptions = [f"- `{name}`: {description}" for name, description in tools.items()]
                     console.print(Markdown("## Available Tools\n\n"+"\n".join(tools_descriptions)))
                     console.rule()
+                elif user_request == ".prompts":
+                    console.rule()
+                    prompts_descriptions = [f"- `{name}`: {description}" for name, description in prompts.items()]
+                    console.print(Markdown("## Available Prompts\n\n"+"\n".join(prompts_descriptions)))
+                    console.rule()
                 elif user_request == ".backend":
                     edit_configurations()
                     console.rule()
@@ -230,8 +237,12 @@ Get a static text-based response directly from a text-based AI model without usi
                 continue
 
             # Check if a single tool is specified
+            specified_prompt = ""
             specified_tool = ""
-            if re.search(f"""^@({available_tools_pattern}) """, user_request):
+            if re.search(prompt_pattern, user_request):
+                specified_prompt = re.search(prompt_pattern, user_request).group(1)
+                user_request = user_request[len(specified_prompt):]
+            elif re.search(f"""^@({available_tools_pattern}) """, user_request):
                 specified_tool = re.search(f"""^@({available_tools_pattern}) """, user_request).group(1)
                 user_request = user_request[len(specified_tool)+2:]
             elif user_request.startswith("@@"):
@@ -302,22 +313,19 @@ Get a static text-based response directly from a text-based AI model without usi
 
             # generate master plan
             if not master_plan:
-                if re.search(prompt_pattern, user_request):
-                    prompt_name = re.search(prompt_pattern, user_request).group(1)
-                    user_request = user_request[len(prompt_name):]
+                if specified_prompt:
                     # Call the MCP prompt
-                    prompt_schema = prompts_schema[prompt_name[1:]]
+                    prompt_schema = prompts_schema[specified_prompt[1:]]
                     prompt_properties = prompt_schema["parameters"]["properties"]
                     if len(prompt_properties) == 1 and "request" in prompt_properties: # AgentMake MCP Servers or alike
-                        result = await client.get_prompt(prompt_name[1:], {"request": user_request})
+                        result = await client.get_prompt(specified_prompt[1:], {"request": user_request})
                     else:
                         structured_output = getDictionaryOutput(messages=messages, schema=prompt_schema)
-                        result = await client.get_prompt(prompt_name[1:], structured_output)
+                        result = await client.get_prompt(specified_prompt[1:], structured_output)
                     #print(result, "\n\n")
                     master_plan = result.messages[0].content.text
                     # display info# display info
                     console.print(Markdown(f"# User Request\n\n{user_request}\n\n# Master plan\n\n{master_plan}"))
-                    console.print(Markdown(f"# User Request\n\n{user_request}\n\n# Master plan\n\n{master_plan}"))
                 else:
                     # display info
                     console.print(Markdown(f"# User Request\n\n{user_request}"), "\n")

{biblemate-0.0.21.dist-info → biblemate-0.0.23.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: biblemate
-Version: 0.0.21
+Version: 0.0.23
 Summary: BibleMate AI - Automate Your Bible Study
 Home-page: https://toolmate.ai
 Author: Eliran Wong
@@ -94,21 +94,63 @@ How to swap?
 * Enter `.chat` in BibleMate AI prompt to enable chat mode and disable agent mode.
 * Enter `.agent` in BibleMate AI prompt to enable agent mode and disable chat mode.
 
-## Specify Toos(s) for a Particular Task
+## Manual Tool Selection
 
+In some cases, you may want to specify a particular tool for a simple task, rather than having a tool automatically selected in the fully automatic `agent mode`.
 
+You can specify a single tool by prefixing a tool name with `@` at the beginning of your prompt. For example,
 
-## Action Menu
+```
+@retrieve_bible_cross_references Deut 6:4; John 3:16
+```
+
+Watch this video: https://youtu.be/50m1KRj6uhs
+
+## Custom Master Plan with Multiple Tools
 
-*(Coming soon)*
+In some cases, you may want to specify a `custom plan` with multiple tools specified for different steps for a complex task, rather than having a `master plan` automatically generated in fully automatic agent mode.
 
-## Keyboard Shortcut
+You can use a custom 'Master Plan' of your own, instead of one generated by BibleMate AI. To do this, start your BibleMate AI prompt with '@@' followed by your own master plan for a Bible study. For example,
 
-*(Coming soon)*
+```
+@@ Analyze John 3:16 with the following steps: 
+1. Call tool 'retrieve_english_bible_verses' for Bible text, 
+2. Call tool 'retrieve_bible_cross_references' for Bible cross-references, 
+3. Call tool 'interpret_new_testament_verse' for interpretation, and 
+4. Call tool 'write_bible_theology' to explain its theology.
+```
 
-## Customization
+Watch this video: https://youtu.be/Lejq0sAx030
+
+The '@@' trick works even when you are using 'chat' mode with 'agent' mode disabled.
+
+## Action Menu
 
-*(Coming soon)*
+There is a set of predefined entries, that starts with a dot sign `.`:
+
+- `.new` - new conversation
+- `.quit` - quit
+- `.backend` - change backend
+- `.chat` - enable chat mode
+- `.agent` - enable agent mode
+- `.tools` - list available tools
+- `.backup` - backup conversation
+- `.open` - open a file or directory, e.g. `.open /home/user/report.html`
+
+## Keyboard Shortcuts
+
+The following key bindings are supported in BibleMate AI prompt field:
+
+- `Ctrl+N` new conversation
+- `Ctrl+Q` quit
+- `Ctrl+C` copy selected prompt text
+- `Ctrl+V` paste text in a prompt
+- `Ctrl+I` or `TAB` new line
+- `Ctrl+Z` clear prompt text
+- `Esc+a` jump to the beginning of a prompt
+- `Esc+z` jump to the end of a prompt
+- `Esc+b` or `HOME` jump to the beginning of a line in a prompt
+- `Esc+e` or `END` jump to the end of a line in a prompt
 
 ## License
 

{biblemate-0.0.21.dist-info → biblemate-0.0.23.dist-info}/RECORD

@@ -1,15 +1,15 @@
-biblemate/README.md,sha256=f1SRN1aIFbtSQW4RFZxeUWGBcBma_JgCw4dRFEou05k,4148
+biblemate/README.md,sha256=0xKiXqwB-WBxHCKyUByD-2Yre0zgflTDun-wYc9o-J0,6173
 biblemate/__init__.py,sha256=aFO4_EperOrwwDBdrkTKfDMt2Fh18Y0A2G_nUC_cmmM,78
-biblemate/bible_study_mcp.py,sha256=lW4pFlfO-98w1yazOIgr2KyWccPFmrNmIReQUEo3--g,16575
+biblemate/bible_study_mcp.py,sha256=-g66m7zB-6bQ-rilmUs5-PPAtXdm_qES2mH8nZ7bGG4,17453
 biblemate/config.py,sha256=ktpLv_5qdbf3FErxUIdCvVc9MO6kQH4Zt_omoJ7msIs,15
-biblemate/main.py,sha256=SWQ2edxSDGcOGvt3s6urUPAunzwqLKd1p1fPkLk-76c,22214
+biblemate/main.py,sha256=O7PKxdJbmjeIU4NomvkHEuaUuMSmjsttWAIot4_IFvU,22614
 biblemate/package_name.txt,sha256=WkkuEEkgw7EKpXV8GshpzhZlwRor1wpotTS7vP24b_g,9
 biblemate/requirements.txt,sha256=MliJX2PmogiVmgqHk4W0TMqRp2FLYXcGIkf8PS2RV94,70
 biblemate/core/systems.py,sha256=nG_NgcLSRhdaHuxuCPN5ZfJUhP88kdfwhRCvRk4RLjI,1874
 biblemate/ui/info.py,sha256=QRCno0CYUHVoOtVkZIxVamZONmtI7KRmOT2YoUagY5s,811
 biblemate/ui/prompts.py,sha256=mxdC5BU7NMok9MOm1E39MHSrxB9gSRqGY7HsOc--rRg,3484
-biblemate-0.0.21.dist-info/METADATA,sha256=RoKKy2efUl2rucC6AYdw4J-JIy2Gw5e1pjen6wCfYVE,5643
-biblemate-0.0.21.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-biblemate-0.0.21.dist-info/entry_points.txt,sha256=tbEfTFr6LhPR1E_zP3CsPwJsmG-G4MCnJ3FcQEMiqo0,50
-biblemate-0.0.21.dist-info/top_level.txt,sha256=pq9uX0tAS0bizZcZ5GW5zIoDLQBa-b5QDlDGsdHNgiU,10
-biblemate-0.0.21.dist-info/RECORD,,
+biblemate-0.0.23.dist-info/METADATA,sha256=P7UDN6G3rrS7uxAxqTqNIfCP5H-bZaorbjbPuxSRfRI,7668
+biblemate-0.0.23.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+biblemate-0.0.23.dist-info/entry_points.txt,sha256=tbEfTFr6LhPR1E_zP3CsPwJsmG-G4MCnJ3FcQEMiqo0,50
+biblemate-0.0.23.dist-info/top_level.txt,sha256=pq9uX0tAS0bizZcZ5GW5zIoDLQBa-b5QDlDGsdHNgiU,10
+biblemate-0.0.23.dist-info/RECORD,,