https://github.com/inference-gateway/documentation-agent

A2A agent server that provides Context7-style documentation capabilities for your agents.
https://github.com/inference-gateway/documentation-agent

a2a a2a-protocol a2a-server oci oci-image

Last synced: 4 months ago
JSON representation

A2A agent server that provides Context7-style documentation capabilities for your agents.

Host: GitHub
URL: https://github.com/inference-gateway/documentation-agent
Owner: inference-gateway
Created: 2025-08-30T11:06:14.000Z (10 months ago)
Default Branch: main
Last Pushed: 2025-09-22T00:56:59.000Z (9 months ago)
Last Synced: 2025-09-22T02:37:25.914Z (9 months ago)
Topics: a2a, a2a-protocol, a2a-server, oci, oci-image
Homepage: https://docs.inference-gateway.com/
Size: 157 KB
Stars: 1
Watchers: 0
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Agents: AGENTS.md

Awesome Lists containing this project

awesome-a2a - Documentation Agent - A2A-compatible agent for libraries and code documentation using Context7 as the underlying data source. (Agents / Documentation)

README

          


# Documentation-Agent

[![CI](https://github.com/inference-gateway/documentation-agent/workflows/CI/badge.svg)](https://github.com/inference-gateway/documentation-agent/actions/workflows/ci.yml)

[![Go Version](https://img.shields.io/badge/Go-1.25.5+-00ADD8?style=flat&logo=go)](https://golang.org)

[![A2A Protocol](https://img.shields.io/badge/A2A-Protocol-blue?style=flat)](https://github.com/inference-gateway/adk)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

**A2A agent server that provides Context7-style documentation capabilities for your agents**

A enterprise-ready [Agent-to-Agent (A2A)](https://github.com/inference-gateway/adk) server that provides AI-powered capabilities through a standardized protocol.



## Quick Start

```bash

# Run the agent

go run .

# Or with Docker

docker build -t documentation-agent .

docker run -p 8080:8080 documentation-agent

```

## Quick Install

Add this agent to your Inference Gateway CLI:

```bash

infer agents add documentation-agent http://localhost:8080 \

  --oci ghcr.io/inference-gateway/documentation-agent:latest \

  --run

```

## Features

- ✅ A2A protocol compliant

- ✅ AI-powered capabilities

- ✅ Streaming support

- ✅ State transition history

- ✅ Enterprise-ready

- ✅ Minimal dependencies

## Endpoints

- `GET /.well-known/agent-card.json` - Agent metadata and capabilities

- `GET /health` - Health check endpoint

- `POST /a2a` - A2A protocol endpoint

## Available Skills

| Skill | Description | Parameters |

|-------|-------------|------------|

| `resolve_library_id` | Resolves library name to Context7-compatible library ID and returns matching libraries | libraryName |

| `get_library_docs` | Fetches up-to-date documentation for a library using Context7-compatible library ID | context7CompatibleLibraryID, tokens, topic |

## Configuration

Configure the agent via environment variables:

| Category | Variable | Description | Default |

|----------|----------|-------------|---------|

| **Server** | `A2A_PORT` | Server port | `8080` |

| **Server** | `A2A_DEBUG` | Enable debug mode | `false` |

| **Server** | `A2A_AGENT_URL` | Agent URL for internal references | `http://localhost:8080` |

| **Server** | `A2A_STREAMING_STATUS_UPDATE_INTERVAL` | Streaming status update frequency | `1s` |

| **Server** | `A2A_SERVER_READ_TIMEOUT` | HTTP server read timeout | `120s` |

| **Server** | `A2A_SERVER_WRITE_TIMEOUT` | HTTP server write timeout | `120s` |

| **Server** | `A2A_SERVER_IDLE_TIMEOUT` | HTTP server idle timeout | `120s` |

| **Server** | `A2A_SERVER_DISABLE_HEALTHCHECK_LOG` | Disable logging for health check requests | `true` |

| **Agent Metadata** | `A2A_AGENT_CARD_FILE_PATH` | Path to agent card JSON file | `.well-known/agent-card.json` |

| **LLM Client** | `A2A_AGENT_CLIENT_PROVIDER` | LLM provider (`openai`, `anthropic`, `azure`, `ollama`, `deepseek`) |`` |

| **LLM Client** | `A2A_AGENT_CLIENT_MODEL` | Model to use |`` |

| **LLM Client** | `A2A_AGENT_CLIENT_API_KEY` | API key for LLM provider | - |

| **LLM Client** | `A2A_AGENT_CLIENT_BASE_URL` | Custom LLM API endpoint | - |

| **LLM Client** | `A2A_AGENT_CLIENT_TIMEOUT` | Timeout for LLM requests | `30s` |

| **LLM Client** | `A2A_AGENT_CLIENT_MAX_RETRIES` | Maximum retries for LLM requests | `3` |

| **LLM Client** | `A2A_AGENT_CLIENT_MAX_CHAT_COMPLETION_ITERATIONS` | Max chat completion rounds | `10` |

| **LLM Client** | `A2A_AGENT_CLIENT_MAX_TOKENS` | Maximum tokens for LLM responses |`4096` |

| **LLM Client** | `A2A_AGENT_CLIENT_TEMPERATURE` | Controls randomness of LLM output |`0.7` |

| **Capabilities** | `A2A_CAPABILITIES_STREAMING` | Enable streaming responses | `true` |

| **Capabilities** | `A2A_CAPABILITIES_PUSH_NOTIFICATIONS` | Enable push notifications | `false` |

| **Capabilities** | `A2A_CAPABILITIES_STATE_TRANSITION_HISTORY` | Track state transitions | `true` |

| **Task Management** | `A2A_TASK_RETENTION_MAX_COMPLETED_TASKS` | Max completed tasks to keep (0 = unlimited) | `100` |

| **Task Management** | `A2A_TASK_RETENTION_MAX_FAILED_TASKS` | Max failed tasks to keep (0 = unlimited) | `50` |

| **Task Management** | `A2A_TASK_RETENTION_CLEANUP_INTERVAL` | Cleanup frequency (0 = manual only) | `5m` |

| **Storage** | `A2A_QUEUE_PROVIDER` | Storage backend (`memory` or `redis`) | `memory` |

| **Storage** | `A2A_QUEUE_URL` | Redis connection URL (when using Redis) | - |

| **Storage** | `A2A_QUEUE_MAX_SIZE` | Maximum queue size | `100` |

| **Storage** | `A2A_QUEUE_CLEANUP_INTERVAL` | Task cleanup interval | `30s` |

| **Authentication** | `A2A_AUTH_ENABLE` | Enable OIDC authentication | `false` |

## Development

```bash

# Generate code from ADL

task generate

# Run tests

task test

# Build the application

task build

# Run linter

task lint

# Format code

task fmt

```

### Debugging

Use the [A2A Debugger](https://github.com/inference-gateway/a2a-debugger) to test and debug your A2A agent during development. It provides a web interface for sending requests to your agent and inspecting responses, making it easier to troubleshoot issues and validate your implementation.

```bash

docker run --rm -it --network host ghcr.io/inference-gateway/a2a-debugger:latest --server-url http://localhost:8080 tasks submit "What are your skills?"

```

```bash

docker run --rm -it --network host ghcr.io/inference-gateway/a2a-debugger:latest --server-url http://localhost:8080 tasks list

```

```bash

docker run --rm -it --network host ghcr.io/inference-gateway/a2a-debugger:latest --server-url http://localhost:8080 tasks get 

```

## Deployment

### Docker

The Docker image can be built with custom version information using build arguments:

```bash

# Build with default values from ADL

docker build -t documentation-agent .

# Build with custom version information

docker build \

  --build-arg VERSION=1.2.3 \

  --build-arg AGENT_NAME="My Custom Agent" \

  --build-arg AGENT_DESCRIPTION="Custom agent description" \

  -t documentation-agent:1.2.3 .

```

**Available Build Arguments:**

- `VERSION` - Agent version (default: `0.2.24`)

- `AGENT_NAME` - Agent name (default: `documentation-agent`)

- `AGENT_DESCRIPTION` - Agent description (default: `A2A agent server that provides Context7-style documentation capabilities for your agents`)

These values are embedded into the binary at build time using linker flags, making them accessible at runtime without requiring environment variables.

## License

MIT License - see LICENSE file for details

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/inference-gateway/documentation-agent

Awesome Lists containing this project

README