Skip to content

Commit 95e2ed8

Browse files
committed
docs: enhance README with project overview and component details
1 parent 12be51b commit 95e2ed8

1 file changed

Lines changed: 17 additions & 1 deletion

File tree

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
11
# AgentBridge
22

3-
This monorepo contains the Agentbridge client library and CLI tool for processing and transforming APIs into the AgentBridge Protocol format.
3+
This monorepo contains the AgentBridge client library and CLI tool for processing and transforming APIs into the AgentBridge Protocol format.
4+
5+
## Overview
6+
7+
AgentBridge simplifies the process of making APIs accessible to AI agents by transforming traditional API specifications into a standardized format optimized for agent consumption. The project consists of two main components:
8+
9+
1. **CLI Tool**: Convert OpenAPI/Swagger specifications to AgentBridge Protocol format
10+
2. **Client Library**: Interact with APIs using AgentBridge Protocol schemas
11+
12+
## Components
13+
14+
- [CLI Tool](packages/cli/README.md) - Command-line interface for converting API specifications
15+
- [Client Library](packages/client/README.md) - TypeScript library for interacting with AgentBridge-compatible APIs
16+
17+
## Getting Started
18+
19+
Check the component-specific READMEs linked above for detailed usage instructions.

0 commit comments

Comments
 (0)