Skip to content

Commit ff689d0

Browse files
committed
Add OSOP README for code review pipeline example
Adds documentation explaining OSOP format and how it maps to Semantic Kernel concepts.
1 parent f7c1093 commit ff689d0

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# OSOP Workflow Examples for Semantic Kernel
2+
3+
[OSOP](https://github.com/osopcloud/osop-spec) (Open Standard for Orchestration Protocols) is a portable YAML format for describing AI workflows — think OpenAPI, but for agent orchestration.
4+
5+
## What's Here
6+
7+
| File | Description |
8+
|------|-------------|
9+
| `code-review-pipeline.osop.yaml` | Automated PR review: fetch diff, parallel analysis (complexity + security + tests), generate review, post comments |
10+
11+
## Why OSOP?
12+
13+
Semantic Kernel provides powerful AI orchestration with plugins, planners, and agents. OSOP provides a **framework-agnostic way to describe** those orchestration patterns so they can be:
14+
15+
- **Documented** — readable YAML that non-developers can understand
16+
- **Validated** — check workflow structure before execution
17+
- **Ported** — same workflow definition works across Semantic Kernel, LangChain, AutoGen, etc.
18+
- **Visualized** — render the workflow as a graph in the [OSOP Editor](https://github.com/osopcloud/osop-editor)
19+
20+
## Quick Start
21+
22+
```bash
23+
# Validate the workflow
24+
pip install osop
25+
osop validate code-review-pipeline.osop.yaml
26+
27+
# Or just read the YAML — it's self-documenting
28+
cat code-review-pipeline.osop.yaml
29+
```
30+
31+
## How It Maps to Semantic Kernel
32+
33+
| OSOP Concept | Semantic Kernel Equivalent |
34+
|---|---|
35+
| `node` with `type: agent` | `ChatCompletionAgent` / `OpenAIAssistantAgent` |
36+
| `node` with `type: api` | Native function / Plugin |
37+
| `edge` with `mode: parallel` | Parallel plugin execution |
38+
| `edge` with `mode: conditional` | `KernelFunction` with conditional logic |
39+
| `config.plugins` | Semantic Kernel plugins |
40+
41+
## Learn More
42+
43+
- [OSOP Spec](https://github.com/osopcloud/osop-spec) — full specification
44+
- [OSOP Examples](https://github.com/osopcloud/osop-examples) — 30+ workflow templates
45+
- [OSOP Editor](https://github.com/osopcloud/osop-editor) — visual workflow editor

0 commit comments

Comments
 (0)