Skip to content

Commit 36d8def

Browse files
committed
add codespaces to sample-basic-demo
1 parent 743111e commit 36d8def

File tree

3 files changed

+35
-6
lines changed

3 files changed

+35
-6
lines changed

docs/Integration-MCP.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
MCP enables Business Users to use Natural Language to create declarative execution flows across multiple business-rule-enforced API services. MCP is an open protocol than enables:
44

5-
1. **MCP Client Executors** to leverage LLMs to tranlate NL queries into multi-step execution flows called **Tool Context Blocks.**.
5+
1. **MCP Client Executors** to leverage LLMs to translate NL queries into multi-step execution flows called **Tool Context Blocks.**.
66
2. The MCP Client Executor executes the Tool Context block steps, making calls on the **MCP Server Executors.**
77

88
* MCP Server Executors are commonly provided via **logic-enabled JSON:APIs.** (Note the logic is critical in maintaining integrity and security.)

docs/Sample-Basic-Demo.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -427,4 +427,33 @@ $ sqlite3 database/db.sqlite
427427
> .exit
428428
```
429429

430-
The SQLite DBMS is installed with API Logic Server, but the **CLI** is not provided on all systems. If it's not installed, [you can install it like this](https://apilogicserver.github.io/Docs/Database-Connectivity/#sqlite).
430+
The SQLite DBMS is installed with API Logic Server, but the **CLI** is not provided on all systems. If it's not installed, [you can install it like this](https://apilogicserver.github.io/Docs/Database-Connectivity/#sqlite).
431+
432+
## Appendix: Setup Codespaces
433+
434+
Codespaces enables you to run in the cloud: VSCode via your Browser, courtesy GitHub. You can use codespaces on your GenAI project:
435+
436+
__1. Open your project on GitHub__
437+
438+
![API Logic Server Intro](images/sample-ai/genai/open-github.png)
439+
440+
__2. Open it in Codespaces (takes a minute or 2):__
441+
442+
![API Logic Server Intro](images/sample-ai/genai/start-codespaces.png)
443+
444+
> You will now see your project - running in VSCode, _in the Browser._ But that's just what you _see..._
445+
446+
> Behind the scenes, Codespaces has requisitioned a cloud machine, and loaded your project - with a _complete development environment_ - Python, your dependencies, git, etc.
447+
448+
> You are attached to this machine in your Browser, running VSCode.
449+
450+
> :trophy: Pretty remarkable.
451+
452+
__3. Start the Server and open the App in the Browser__
453+
454+
* Use the pre-defined Launch Configuration
455+
456+
![API Logic Server Intro](images/git-codespaces/start-codespaces.png)
457+
458+
459+
We think you'll find Codespaces pretty amazing - check it out!

docs/Sample-Genai.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@
1717

1818
Codespaces enables you to run in the cloud: VSCode via your Browser, courtesy GitHub. You can use codespaces on your GenAI project:
1919

20-
1. Open your project on GitHub
20+
__1. Open your project on GitHub__
2121

2222
![API Logic Server Intro](images/sample-ai/genai/open-github.png)
2323

24-
2. Open it in Codespaces (takes a minute or 2):
24+
__2. Open it in Codespaces (takes a minute or 2):__
2525

2626
![API Logic Server Intro](images/sample-ai/genai/start-codespaces.png)
2727

@@ -44,7 +44,7 @@ We think you'll find Codespaces pretty amazing - check it out!
4444

4545
 
4646

47-
## How was the project created?
47+
### How was the project created?
4848

4949
Your prompt (whether provided in a file to the CLI, or the WebGenAI website)
5050
is sent to ChatGPT to create a schema. This schema is then processed by als to create
@@ -170,7 +170,7 @@ The system saves files used for creation:
170170

171171
![Customize](images/sample-ai/copilot/diagnostic_info.png)
172172

173-
Note there are multiple diagostic directories. recall GenAI results are not always predictable, so we make 3 attempts to get a successful result. This is often enough, but examining the failures can be useful.
173+
Note there are multiple diagnostic directories. recall GenAI results are not always predictable, so we make 3 attempts to get a successful result. This is often enough, but examining the failures can be useful.
174174

175175
A good technique is to:
176176

0 commit comments

Comments
 (0)