Skip to content

Commit 1f0dcd1

Browse files
docs(examples): add README for examples directory
1 parent d3ac6dd commit 1f0dcd1

1 file changed

Lines changed: 49 additions & 0 deletions

File tree

examples/README.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# ClientAgentJS Examples
2+
3+
This directory contains practical examples demonstrating how to use ClientAgentJS in different scenarios.
4+
5+
## Available Examples
6+
7+
### [Chat Explorer](./browser-basic/)
8+
9+
A full-featured chat interface demonstrating sessions, streaming, event logs, and configuration portability.
10+
11+
**Key features:**
12+
- Multi-turn chat sessions with conversation memory
13+
- Real-time streaming responses with cancellation support
14+
- Markdown rendering of agent responses
15+
- Profile management (OpenAI, Anthropic, Google, Ollama)
16+
- MCP server integration
17+
- Configuration export/import
18+
19+
### [Form Assistance](./form-assistance/)
20+
21+
AI-powered form assistance demonstrating how to add AI help to standard web forms.
22+
23+
**Key features:**
24+
- Attaching AI actions to form fields
25+
- Generating and improving text content
26+
- Using `ask()` and `stream()` as field-level helpers
27+
- Injecting form context into AI requests
28+
29+
### [MCP Tools](./mcp-tools/)
30+
31+
Model Context Protocol integration example showing how to connect the agent to external tools.
32+
33+
**Key features:**
34+
- Configuring and saving MCP servers
35+
- Listing and calling remote tools
36+
- Enabling MCP servers in profiles
37+
- Running AI requests with tool access
38+
39+
## Documentation
40+
41+
For detailed API documentation and architecture information, see:
42+
43+
- [Documentation Index](../docs/README.md)
44+
- [API Reference](../docs/api.md)
45+
- [Architecture Overview](../docs/architecture.md)
46+
47+
---
48+
49+
See license: https://github.com/FranBarInstance/ClientAgentJS

0 commit comments

Comments
 (0)