Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
9a1040a
microbots intro
shivashanmugam Apr 17, 2026
31097a8
removing app.js file from the examples folder
shivashanmugam Apr 20, 2026
8eaac5d
fix pr comments
shivashanmugam Apr 21, 2026
41cb5a2
remove the os import
shivashanmugam Apr 21, 2026
69a627e
Merge remote-tracking branch 'origin/main' into siva/getting-started-…
shivashanmugam Apr 27, 2026
c1272af
fix comments
shivashanmugam Apr 28, 2026
06b333b
change python to python3
shivashanmugam Apr 28, 2026
441a4e1
changes getting started
shivashanmugam May 18, 2026
a7f4714
update getting started with minimal text as suggessted
shivashanmugam May 18, 2026
b459d87
first bot changes
shivashanmugam May 18, 2026
7efb73c
Merge remote-tracking branch 'origin/main' into siva/getting-started-…
shivashanmugam May 18, 2026
206175a
change blog to blog posts
shivashanmugam May 18, 2026
a35b180
fix title and quick start icon
shivashanmugam May 18, 2026
11dea06
remove home markdown file
shivashanmugam May 18, 2026
0b1ae73
update getting started
shivashanmugam May 18, 2026
8dc76e3
getting-started changes
shivashanmugam May 18, 2026
43f89c7
remove unwanted image
shivashanmugam May 18, 2026
f4a1178
resolve pr comments
shivashanmugam May 23, 2026
691a41d
asset folder changes and resolve pr comments
shivashanmugam May 23, 2026
afad9d3
resolve comments on installation guide article, microbots installatio…
shivashanmugam May 23, 2026
f23e783
better info text
shivashanmugam May 23, 2026
9f466ff
add better info text
shivashanmugam May 23, 2026
c565f53
Merge branch 'siva/getting-started-with-microbots' of https://github.…
shivashanmugam May 23, 2026
0a57e13
add explanation for bot construct and bot.run as per pr comment
shivashanmugam May 26, 2026
0c9c08e
resolve pr comments
shivashanmugam May 26, 2026
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
107 changes: 45 additions & 62 deletions README.md
Comment thread
0xba1a marked this conversation as resolved.
Original file line number Diff line number Diff line change
@@ -1,97 +1,80 @@
# 🤖 Microbots

MicroBots is a lightweight, extensible AI agent for code comprehension and controlled file edits. It integrates cleanly
into automation pipelines, mounting a target directory with explicit read-only or read/write modes so LLMs can safely
inspect, refactor, or generate files with least‑privilege access.
MicroBots is a lightweight, extensible AI agent for code comprehension and controlled file edits. It integrates cleanly into automation pipelines, mounting a target directory with explicit read-only or read/write modes so LLMs can safely inspect, refactor, or generate files with least-privilege access.


```py
from microbots import WritingBot

myWritingBot = WritingBot(
model="azure-openai/my-gpt5", # model format : <provider/deployment_model_name>
folder_to_mount=str("myReactApp"),
)

data = myWritingBot.run("""when doing npm run build, I get an error.
Fix the error and make sure the build is successful.""", timeout_in_seconds=600)
print(data.results)
```

## 🚀 How to install
## 🚀 Quick Start

### Pre-requisites

- Docker
- AI LLM Provider and API Key

### Install Microbots
### Install

```bash
pip install microbots
```

### Example

## ✨LLM Support
```python
from microbots import WritingBot

Azure OpenAI Models - Add the below environment variables in a `.env` file in the root of your application
myWritingBot = WritingBot(
model="azure-openai/my-gpt5",
folder_to_mount=str("myReactApp"),
)

```env
AZURE_OPENAI_ENDPOINT=XXXXXXXXXXXXXXXXXXXXXXXXXX
AZURE_OPENAI_API_KEY=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
AZURE_OPENAI_API_VERSION=2025-03-01-preview
data = myWritingBot.run(
"Fix the build error and make sure the build is successful.",
timeout_in_seconds=600,
)
print(data.results)
```

## 🤖 Bots & Usage Examples

Pre-requisite for the below example code of Bots:
From the root of your application, Create a folder called `code` inside which clone the repo `https://github.com/swe-agent/test-repo/`. Now run the code


### 📖 ReadingBot


```py
from microbots import ReadingBot

myBot = ReadingBot(
model="azure-openai/my-gpt5",
folder_to_mount="code"
)
## 🤖 Available Bots

runResult = myBot.run("When I am running missing_colon.py I am getting SyntaxError: invalid syntax. Find the error and explain me what is the error", timeout_in_seconds=600)
print(runResult)
| Bot | Description |
| ------------------ | ---------------------------------------------------------------------- |
| **ReadingBot** | Reads files and extracts information based on instructions (read-only) |
| **WritingBot** | Reads and writes files based on instructions (read/write) |
| **BrowsingBot** | Browses the web to gather information |
| **LogAnalysisBot** | Analyzes logs for debugging |
| **AgentBoss** | Orchestrates multiple bots for complex tasks |

```
## ⚙️ How it works

The `ReadingBot` will read the files inside `code` folder and will extract information based on specific instructions given to the bot.
![Overall Architecture](https://raw.githubusercontent.com/microsoft/microbots/main/docs/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.

### ✍️ WritingBot
## ✨ LLM Support

Pre-requisite for the example code:
From the root the application, Create a folder called `code` inside which clone the repo `https://github.com/swe-agent/test-repo/`. Now run the code
Microbots supports multiple LLM providers — pick whichever fits your stack:

```py
from microbots import WritingBot
| Provider string | Description |
| --------------- | ---------------------------------------------------------- |
| `openai` | OpenAI or Azure OpenAI via the OpenAI SDK (API key) |
| `azure-openai` | Azure OpenAI via the Azure SDK (API key or Azure AD token) |
| `anthropic` | Anthropic models, direct or via Azure AI Foundry |
| `ollama-local` | Local models via [Ollama](https://ollama.com/) |

myBot = WritingBot(
model="azure-openai/my-gpt5",
folder_to_mount="code"
)
Each provider has its own set of environment variables (endpoint, API key, deployment name, etc.). See the [Authentication guide](https://microsoft.github.io/microbots/advanced/authentication/) for the exact `.env` variables required for each provider and for Azure AD / managed identity setup.

myBot.run("When I am running missing_colon.py I am getting SyntaxError: invalid syntax. Fix the error and make sure the code runs without any errors.", timeout_in_seconds=600)
```
## 📚 Links

The `WritingBot` will read and write the files inside `code` folder based on specific instructions given to the bot.
- [GitHub Repository](https://github.com/microsoft/microbots)
- [Contributing Guide](https://github.com/microsoft/microbots/blob/main/CONTRIBUTING.md)
- [Code of Conduct](https://github.com/microsoft/microbots/blob/main/CODE_OF_CONDUCT.md)

## ⚙️ How it works
---

## 🎯 Getting Started

![Overall Architecture Image](./docs/images/overall_architecture.png)
Ready to build your first Microbot project? Follow the step-by-step onboarding guide:

The MicroBots create a containerized environment and mount the specified directory with restricting the permissions to read-only or read/write based on Bot used. It ensures that the AI agents operate within defined boundaries which enhances security and control over code modifications as well as protecting the local environment.
➡️ **[Get Started with Microbots](https://microsoft.github.io/microbots/getting-started/prerequisites/)**

#Legal Notice
## Legal Notice

Trademarks This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsofts Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-partys policies.
Trademarks: this project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -259,5 +259,5 @@ One identity, one service connection, many Microbots pipelines.
## Next Steps

- **Conceptual background** → [Understanding RBAC & Authentication](../blog/rbac-authentication.md)
- **All authentication options** → [Authentication Setup](../authentication.md)
- **All authentication options** → [Authentication Setup](authentication.md)
- **Why secret-less matters** → [Microbots: Safety First Agentic Workflow](../blog/microbots-safety-first-ai-agent.md)
File renamed without changes.
Loading
Loading