https://github.com/oscarcitoz/agent-config
Kotlin microservice for managing agents, configurations, and tools. Integrates with AI systems like OpenAI and Amazon Bedrock. Uses PostgreSQL and supports agent retrieval by ID or similarity (via Vector DB).
https://github.com/oscarcitoz/agent-config
agent-management ai-integration kotlin microservice openai postgresql tool-management vector-db
Last synced: 4 months ago
JSON representation
Kotlin microservice for managing agents, configurations, and tools. Integrates with AI systems like OpenAI and Amazon Bedrock. Uses PostgreSQL and supports agent retrieval by ID or similarity (via Vector DB).
- Host: GitHub
- URL: https://github.com/oscarcitoz/agent-config
- Owner: oscarcitoz
- Created: 2025-01-22T09:45:09.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-01-22T19:02:42.000Z (over 1 year ago)
- Last Synced: 2025-01-22T19:22:15.383Z (over 1 year ago)
- Topics: agent-management, ai-integration, kotlin, microservice, openai, postgresql, tool-management, vector-db
- Language: Kotlin
- Homepage:
- Size: 62.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Agent Config Microservice
## Overview
The `Agent Config` microservice is responsible for managing agents, their configurations, and tools. It serves as an intermediary for the `Converse` microservice, providing necessary agent context and tools for communication with AI systems like OpenAI or Amazon Bedrock.
## Documentation
Puedes encontrar la colección completa de Postman con todos los endpoints aquí:
[Colección Postman](https://sumer-07062021.postman.co/workspace/SUMER~148b538f-9145-4526-8806-bb1cc611d3bd/collection/16642082-cb410cc2-8ada-45d5-b47d-b3d303bee5fe?action=share&creator=16642082&active-environment=16640760-5fde9fd8-7328-4098-8d82-c9d5fa254624)
## Construcción y Ejecución
### Usando Docker
1. Construir la imagen Docker (incluye la compilación):
```bash
docker build -t agent-config-ms .
```
2. Ejecutar el contenedor:
```bash
docker run -p 8080:8080 agent-config-ms
```
3. Para detener el contenedor:
```bash
docker stop $(docker ps -q --filter ancestor=agent-config-ms)
```
El servicio estará disponible en `http://localhost:8080`
### Construcción local (alternativa)
Si prefieres construir y ejecutar localmente sin Docker:
```bash
./gradlew clean build
./gradlew run
```
This microservice is written in Kotlin and uses PostgreSQL as its database. It has three main tables:
- **agent_configs**: Stores the configuration details of each agent.
- **tools**: Stores the details of various tools.
- **agent_tool**: Represents the relationship between agents and their tools.
## Features
1. **Agent Configuration Management**: Create and manage agent configurations.
2. **Tool Management**: Add, associate, and remove tools for agents.
3. **Agent Retrieval**:
- Retrieve an agent by its `agent_id`.
- Retrieve an agent by query similarity via a separate microservice called `Vector DB`.
## Endpoints
### 1. Create an Agent Configuration
**Endpoint:**
```http
POST /api/ms/agent/config
```
**Request Headers:**
```
Content-Type: application/json
```
**Request Body:**
```json
{
"agent_id": "mi_primer_agente",
"preferences": {
"example_response": "dasdasdas"
}
}
```
**Description:**
Creates a new agent configuration.
---
### 2. Create a Tool
**Endpoint:**
```http
POST /api/ms/agent/tool
```
**Request Headers:**
```
Content-Type: application/json
```
**Request Body:**
```json
{
"name": "mi_primera_herramienta",
"description": "Descripción de la herramienta",
"type": "Tipo de la herramienta",
"config": {"xasxa": "xaaz"}
}
```
**Description:**
Creates a new tool.
---
### 3. Associate a Tool with an Agent
**Endpoint:**
```http
POST /api/ms/agent/config/{agent_id}/tools/{tool_name}
```
**Description:**
Associates an existing tool with a specific agent.
**Example:**
```bash
curl --location --request POST 'http://localhost:8080/api/ms/agent/config/mi_primer_agente/tools/mi_primera_herramienta'
```
---
### 4. Remove a Tool from an Agent
**Endpoint:**
```http
DELETE /api/ms/agent/config/{agent_id}/tools/{tool_name}
```
**Description:**
Removes the association between a tool and an agent.
**Example:**
```bash
curl --location --request DELETE 'http://localhost:8080/api/ms/agent/config/mi_primer_agente/tools/mi_primera_herramienta'
```
---
### 5. Retrieve an Agent by Query Similarity
**Description:**
To retrieve an agent by query similarity, the `Agent Config` microservice communicates with the `Vector DB` microservice. This external microservice handles the similarity search and returns the most relevant agent.
---
## Technologies Used
- **Programming Language:** Kotlin
- **Database:** PostgreSQL
- **API Framework:** Micronaut
- **Containerization:** Docker
## Running Locally
1. Clone the repository.
2. Ensure PostgreSQL is installed and running.
3. Update the database configuration in the application properties.
4. Run the application using:
```bash
./gradlew run
```
## Notes
- Make sure the `Vector DB` microservice is up and running to use the query similarity feature.
- Customize the database schema and table names as needed.
## Future Improvements
- Add more detailed logging.
- Enhance security features such as authentication and authorization.
- Implement rate limiting for API endpoints.