Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/examples/microbots_introduction/code/app.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
// app.ts — A simple greeting function with a syntax error
function greet(name: string) {
const message: string = `Hello, ${name}!`
console.log(message)
}

// Missing closing parenthesis on the type annotation
function add(a: number, b: number: number {
return a + b;
}

greet("Microbots");
console.log(add(2, 3));
20 changes: 20 additions & 0 deletions docs/examples/microbots_introduction/log_analysis_bot.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
import logging

logging.basicConfig(level=logging.INFO)

from dotenv import load_dotenv

load_dotenv()
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

load_dotenv() will be used if environment variables are stored in a file named .env. As in your example, you are explicitely setting env variables, you may not need .env


from microbots import LogAnalysisBot

my_bot = LogAnalysisBot(
model="azure-openai/gpt-5-swe-agent",
folder_to_mount="code",
)

result = my_bot.run(
file_name="code/build.log",
timeout_in_seconds=600,
)
print(result.result)
2 changes: 1 addition & 1 deletion docs/index.md → docs/getting-started/home.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ print(data.results)

## ⚙️ How it works

![Overall Architecture](images/overall_architecture.png)
![Overall Architecture](../images/overall_architecture.png)

MicroBots creates a containerized environment and mounts the specified directory, restricting permissions to read-only or read/write based on the Bot used. This ensures AI agents operate within defined boundaries, enhancing security and control over code modifications while protecting the local environment.

Expand Down
File renamed without changes.
File renamed without changes.

Large diffs are not rendered by default.

22 changes: 22 additions & 0 deletions docs/guides/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Guides

Explore the Microbots guides to learn how to use the framework effectively.

## Bots

| Guide | Description |
|-------|-------------|
| [Microbots : Introduction, Installation Guide and Creating Your First MicroBot](bots/microbots-introduction-installation-guide-creating-your-first-bot.md) | Get started with Microbots — learn the basics, install prerequisites, and create your first LogAnalysisBot |
| [CopilotBot](bots/copilot-bot.md) | Use CopilotBot for AI-assisted coding workflows |

## Tools

| Guide | Description |
|-------|-------------|
| [Custom Tool Integration Walkthrough](tools/tesseract_ocr_tool_use.md) | Build and integrate custom tools with Microbots |

## Advanced

| Guide | Description |
|-------|-------------|
| [Authentication](advanced/authentication.md) | Configure Azure AD tokens, managed identity, and service principals |
14 changes: 10 additions & 4 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,17 +36,23 @@ markdown_extensions:
- pymdownx.tabbed:
alternate_style: true
- admonition
- pymdownx.details
- tables
- attr_list
- md_in_html

nav:
- Getting Started:
- Home: index.md
- Home: getting-started/home.md
- Guides:
- CopilotBot: copilot-bot.md
- Authentication: authentication.md
- guides/index.md
- Bots:
- "Microbots : Introduction, Installation Guide and Creating Your First MicroBot": guides/bots/microbots-introduction-installation-guide-creating-your-first-bot.md
- CopilotBot: guides/bots/copilot-bot.md
- Tools:
- "Custom Tool Integration Walkthrough": blog/guides/tesseract_ocr_tool_use.md
- "Custom Tool Integration Walkthrough": guides/tools/tesseract_ocr_tool_use.md
- Advanced:
- Authentication: guides/advanced/authentication.md
- Blogs:
- blog/index.md
- "Microbots : Safety First Agentic Workflow": blog/microbots-safety-first-ai-agent.md
Expand Down
Loading