|
1 | 1 | # Changelog |
2 | 2 |
|
3 | | -All notable changes to the AgentVault project will be documented in this file. |
| 3 | +All notable changes to this project will be documented in this file. |
4 | 4 |
|
5 | 5 | The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), |
6 | | -and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html) for its individual published packages (`agentvault`, `agentvault-cli`, `agentvault-server-sdk`). |
7 | | - |
8 | | -## [Unreleased] |
9 | | - |
10 | | -### Added |
11 | | -- *(Add new features for the next release here)* |
12 | | - |
13 | | -### Changed |
14 | | -- *(Add changes for the next release here)* |
15 | | - |
16 | | -### Fixed |
17 | | -- *(Add bug fixes for the next release here)* |
18 | | - |
19 | | ---- |
20 | | - |
21 | | -## [v0.2.1] / [v0.1.1] - 2025-04-16 |
22 | | - |
23 | | -This release focuses primarily on major documentation improvements, adding comprehensive examples, and enhancing the usability of the registry's developer portal UI based on the established v0.2.0/v0.1.0 functionality. |
24 | | - |
25 | | -### Package Versions |
26 | | -- `agentvault`: 0.2.1 |
27 | | -- `agentvault-cli`: 0.1.1 |
28 | | -- `agentvault-server-sdk`: 0.1.1 |
29 | | - |
30 | | -### Added |
31 | | -- **New Examples:** |
32 | | - - OAuth2 Client Credentials agent (`examples/oauth_agent_example/`) |
33 | | - - Stateful agent demonstrating multi-turn interactions (`examples/stateful_agent_example/`) |
34 | | - - Direct client library usage script (`examples/library_usage_example/`) |
35 | | -- **New Documentation Pages:** |
36 | | - - `docs/vision.md`: Articulates the project's long-term goals and potential. |
37 | | - - `docs/use_cases.md`: Provides detailed scenarios illustrating AgentVault's value, including Mermaid diagrams. |
38 | | - - Copied example READMEs into `docs/examples/` for inclusion in the main documentation site. |
39 | | -- **Developer Portal UI:** |
40 | | - - Status filter dropdown structure (HTML/CSS). |
41 | | - - "Cancel Edit" button in the submit/update form. |
42 | | - - Clearer visual distinction for active/inactive cards. |
43 | | - - Status badges (Active/Inactive) displayed prominently on cards. |
44 | | - - "Verified Dev" badge displayed on cards. |
45 | | - - Header explicitly identifies the "Developer Portal". |
46 | | - - "Logged in as" indicator structure. |
47 | | - - Implemented JavaScript logic for status filtering, status toggling (Activate/Deactivate), cancel edit, and login verification via API call. |
48 | | - |
49 | | -### Changed |
50 | | -- **Documentation Overhaul:** |
51 | | - - Consolidated documentation source into the `/docs` directory. |
52 | | - - Restructured `mkdocs.yml` navigation for better organization. |
53 | | - - Significantly enhanced all component developer guides (`library.md`, `server_sdk.md`, `registry.md`, `testing.md`) with more detail, clearer explanations, and improved examples. |
54 | | - - Updated `ROADMAP.md` to reflect current project status (Phase 2.5) and future plans (including developer self-registration). |
55 | | - - Updated `installation.md` for clarity between user/dev setup and added notes about public registry/cold starts. |
56 | | - - Updated `index.md`, `architecture.md`, `registry.md`, `cli.md` to include links/mentions of the public registry instance and Web UI. |
57 | | - - Updated policy documents (`PRIVACY_POLICY.md`, `TERMS_OF_SERVICE.md`, `REGISTRY_POLICY.md`, `CODE_OF_CONDUCT.md`, `security_policy.md`) to use clearer placeholders for contact information. |
58 | | - - Updated `a2a_profile_v0.2.md` with more implementation details and clarifications. |
59 | | -- **Developer Portal UI:** |
60 | | - - Renamed "Edit" button to "View / Edit". |
61 | | - - Replaced "Deactivate" button with a "Toggle Status" button. |
62 | | - - Improved CSS styling for clarity, spacing, and responsiveness. |
63 | | - |
64 | | -### Fixed |
65 | | -- **Documentation:** |
66 | | - - Corrected numerous broken internal links after file restructuring. |
67 | | - - Fixed Mermaid diagram rendering issues in `architecture.md` by enabling the theme feature, removing internal comments, and simplifying link text syntax. |
68 | | - - Fixed broken links on `examples.md` overview page. |
69 | | -- **Developer Portal UI:** |
70 | | - - Ensured inactive cards are displayed in the "My Agent Cards" list. |
71 | | - - Corrected API call logic in `loadOwnedCards` to fetch necessary details for rendering status. |
72 | | - |
73 | | ---- |
74 | | - |
75 | | -## [v0.2.0] - 2025-04-15 (Baseline for `agentvault` library) |
76 | | - |
77 | | -### Added |
78 | | -- **Core Client Library (`agentvault`):** |
79 | | - - `AgentVaultClient` for A2A communication (JSON-RPC POST, SSE). |
80 | | - - Support for `apiKey`, `oauth2` (Client Credentials), and `none` authentication schemes. |
81 | | - - `KeyManager` for secure local credential management (env, file, keyring). |
82 | | - - Pydantic models for `AgentCard`, A2A protocol messages (`Message`, `Part`, `Task`, `TaskState`, `Artifact`), and SSE events. |
83 | | - - Utilities for Agent Card parsing/validation (`agent_card_utils`). |
84 | | - - Basic utilities for MCP context handling (`mcp_utils`). |
85 | | - - Custom exception hierarchy (`exceptions.py`). |
86 | | - |
87 | | ---- |
88 | | - |
89 | | -## [v0.1.0] - 2025-04-15 (Initial Baseline for CLI, SDK, Registry, Testing) |
90 | | - |
91 | | -### Added |
92 | | -- **Command Line Interface (`agentvault-cli`):** |
93 | | - - `config` command group for managing local credentials (`set`, `get`, `list`). |
94 | | - - `discover` command for searching the registry API. |
95 | | - - `run` command for executing tasks on agents via A2A protocol, including SSE streaming output with `rich` formatting and artifact saving. |
96 | | -- **Server SDK (`agentvault-server-sdk`):** |
97 | | - - `BaseA2AAgent` abstract class defining the agent interface. |
98 | | - - `@a2a_method` decorator for exposing custom/standard methods. |
99 | | - * `create_a2a_router` helper for FastAPI integration, handling JSON-RPC routing and SSE setup. |
100 | | - * `BaseTaskStore` interface and `InMemoryTaskStore` implementation for state management. |
101 | | - * `TaskContext` base dataclass. |
102 | | - * SDK Exception types (`AgentServerError`, `TaskNotFoundError`, etc.). |
103 | | - * `agentvault-sdk package` CLI tool for generating Docker artifacts. |
104 | | -- **Registry API (`agentvault_registry`):** |
105 | | - * FastAPI application serving RESTful endpoints (`/api/v1`). |
106 | | - * Endpoints for Agent Card CRUD operations (POST, GET list, GET by ID, PUT, DELETE/deactivate). |
107 | | - * Developer authentication using hashed API keys (`X-Api-Key`). |
108 | | - * Agent Card validation against the core library schema. |
109 | | - * PostgreSQL database backend with Alembic migrations. |
110 | | - * Basic rate limiting (`slowapi`) and CORS middleware. |
111 | | - * `/utils/validate-card` endpoint. |
112 | | - * Basic static file serving for Web UI (`/ui`, `/ui/developer`). |
113 | | -- **Testing Utilities (`agentvault-testing-utils`):** |
114 | | - * `MockAgentVaultClient` for mocking client interactions. |
115 | | - * `mock_a2a_server` pytest fixture using `respx` for mocking HTTP endpoints. |
116 | | - * `create_test_agent_card` factory function. |
117 | | - * `EchoAgent` basic test agent implementation. |
118 | | - * Assertion helpers (`assert_a2a_call`, `assert_a2a_sequence`). |
119 | | -- **Initial Examples:** |
120 | | - - Basic A2A Server example. |
121 | | - - LangChain Tool integration example. |
122 | | -- **Initial Documentation:** Structure using MkDocs, core concept pages, initial guides. |
123 | | -- **CI/CD:** Basic workflows for dependency audit and docs deployment. |
124 | | - |
125 | | ---- |
| 6 | +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). |
| 7 | + |
| 8 | +## [1.0.0] - 2025-05-02 |
| 9 | + |
| 10 | +### Overview |
| 11 | + |
| 12 | +This is the first major release of AgentVault, marking the project as production-ready. All core components have been thoroughly tested and are ready for deployment. |
| 13 | + |
| 14 | +### Components |
| 15 | + |
| 16 | +- **agentvault** (Library): 1.0.0 - Core Python client library for A2A protocol |
| 17 | +- **agentvault-cli**: 1.0.0 - Command-line interface for AgentVault |
| 18 | +- **agentvault-registry-api**: 1.0.0 - Central registry API service |
| 19 | +- **agentvault-server-sdk**: 1.0.0 - SDK for building A2A compliant agents |
| 20 | +- **agentvault-testing-utils**: 1.0.0 - Shared testing utilities |
| 21 | + |
| 22 | +### Major Features |
| 23 | + |
| 24 | +#### Library (agentvault) |
| 25 | +- Complete A2A protocol implementation |
| 26 | +- MCP (Model Context Protocol) support |
| 27 | +- Secure local key management |
| 28 | +- OAuth2 authentication support |
| 29 | +- Environment variable and OS keyring integration |
| 30 | +- Comprehensive testing suite |
| 31 | + |
| 32 | +#### CLI (agentvault-cli) |
| 33 | +- Agent management commands (list, run, install) |
| 34 | +- Configuration management |
| 35 | +- Registry interaction |
| 36 | +- Key management utilities |
| 37 | +- Rich terminal output with progress indicators |
| 38 | + |
| 39 | +#### Registry API (agentvault-registry-api) |
| 40 | +- RESTful API for agent discovery |
| 41 | +- User authentication and authorization |
| 42 | +- Email verification system |
| 43 | +- Rate limiting and security features |
| 44 | +- PostgreSQL database with async support |
| 45 | +- Comprehensive API documentation |
| 46 | + |
| 47 | +#### Server SDK (agentvault-server-sdk) |
| 48 | +- FastAPI-based framework for building agents |
| 49 | +- Easy route registration |
| 50 | +- Built-in authentication middleware |
| 51 | +- Docker packaging support |
| 52 | +- CLI tool for agent scaffolding |
| 53 | + |
| 54 | +#### Testing Utils (agentvault-testing-utils) |
| 55 | +- Shared mocks and fixtures |
| 56 | +- HTTP request mocking utilities |
| 57 | +- Test helpers for all components |
| 58 | + |
| 59 | +### Security |
| 60 | + |
| 61 | +- All sensitive configuration handled through environment variables |
| 62 | +- No hardcoded secrets or credentials |
| 63 | +- Proper .gitignore configuration |
| 64 | +- JWT-based authentication |
| 65 | +- Secure password hashing with bcrypt |
| 66 | +- Email verification for user accounts |
| 67 | + |
| 68 | +### Documentation |
| 69 | + |
| 70 | +- Comprehensive README files for all components |
| 71 | +- API documentation via OpenAPI/Swagger |
| 72 | +- Configuration guides |
| 73 | +- Security scanning tools included |
| 74 | + |
| 75 | +### Infrastructure |
| 76 | + |
| 77 | +- Docker support with multi-stage builds |
| 78 | +- Poetry-based dependency management |
| 79 | +- Monorepo structure with workspace support |
| 80 | +- CI/CD ready configuration |
| 81 | + |
| 82 | +### Known Issues |
| 83 | + |
| 84 | +- None reported |
| 85 | + |
| 86 | +### Breaking Changes |
| 87 | + |
| 88 | +- This is the first major release, establishing the baseline API |
| 89 | + |
| 90 | +### Upgrade Notes |
| 91 | + |
| 92 | +As this is the first major release, there are no upgrade notes from previous versions. |
| 93 | + |
| 94 | +## Previous Versions |
| 95 | + |
| 96 | +### [0.2.1] - Library Pre-release |
| 97 | +- Initial A2A protocol implementation |
| 98 | +- Basic key management features |
| 99 | + |
| 100 | +### [0.1.1] - Components Pre-release |
| 101 | +- Initial CLI implementation |
| 102 | +- Registry API scaffolding |
| 103 | +- Server SDK framework |
| 104 | + |
| 105 | +### [0.1.0] - Initial Development |
| 106 | +- Project structure setup |
| 107 | +- Basic monorepo configuration |
0 commit comments