Skip to content

agent hub docs #80

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ Internet of Agents Components

pages/dir
pages/dir-howto
pages/agent_hub

.. toctree::
:caption: Agent Manifest
Expand Down
Binary file added docs/pages/hub/_static/agent.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/pages/hub/_static/directory.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/pages/hub/_static/explore.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/pages/hub/_static/login.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
120 changes: 120 additions & 0 deletions docs/pages/hub/agent_hub.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
# Agent Hub

The Agent Hub is designed to provide a robust multi-tenant platform for hosting and managing agent repositories. Its primary aim is to deliver a hub-like user experience, offering easy navigation and management for users. The Agent Hub acts as a centralized point for organizing and accessing agent repositories. This service is enhanced by a gRPC API that supports efficient service communication and integration, ensuring seamless interaction between components.

The Agent Hub serves as the central platform for hosting and managing various agent-related services. The main purpose is to provide a comprehensive solution for developers and IT admins to register, discover, and manage agents in an organized manner. By offering a secure environment for authentication and user management, it ensures that organizations can confidently manage their agent directories and related services.

## Features

The Agent Hub enables users to:

* View and search for public agent repositories.
* Create repositories.
* Publish records.
* Access multiple separate tenants.

## Using the Agent Hub

### Signing up for the Agent Hub and Logging in

To get started with the Agent Hub, sign up at the [Agent Hub homepage](https://phoenix.dev.outshift.ai) for free. You can create a dedicated account with your email address or use one of several SSO options. Once your account is created, you simply log in.

![Logging in](./_static/login.png)

### Explore Page

The Explore page offers an overview of the agent repositoriess registered and enables the user to explore them.

![The Explore Page](./_static/explore.png)

You can refine the results using predefined filters and open search:

* Use the **Search** bar to search for a text string in a repository name. To clear the search bar, click the **×**.
* Use the drop-down **Filters** list to narrow the results by Agent Skill.
* Use the drop-down **Sort by** list to sort the displayed items by Most Recent or Oldest.

You can change tenants by clicking the Tenant drop-down list and selecting another tenant.

### Agent Details

Clicking on an agent repository opens the Agent Details page with further information on the agent repository.

![The Agent Details Page](./_static/agent.png)

The **General** tab lists the following information:

* A description of the agent.
* The creator of the agent.
* The skills associated with the agent.
* The version number and date of publishing.
* The CLI command to pull the agent's directory.

The **Versions** tab lists the published versions of the agent.

The **Settings** tab allows the owner to change the description and the visibility of the agent.

### Agent Directory Page

The Agent Directory Page allows you to view, edit, and create agent repositories in the Agent Hub. Here the records are displayed in a table with customizable columns.

You can select which columns are displayed, and in which order, by clicking the **Arrange Columns** button (***▥***).

You can reload the listed items by clicking the **Reload** button (**⟳**).

You can refine the results using predefined filters and open search:

* Use the **Search** bar to search for a text string in an agent repository name. To clear the search, click the **×**.
* Use the drop-down **Filters** list to narrow the results by Agent Skill.
* Use the drop-down **Sort by** list to sort the displayed items by Most Recent or Oldest.

![The Agent Directory Page](./_static/directory.png)

#### Agent Actions

Clicking the three dots (**⁝**) at the end of any record in the Agent Directory table opens a drop-down list of actions you can perform on that agent reopsitory.

* Click **Open Details** to view the agent.
* Click **Edit** to edit the agent.
* Click **Delete** to delete the agent.

#### Create

To list an agent in the Agent Hub:

1. Click the **+ New Repository** button.
1. Enter the repository name and description.
1. Select the visibility for your agent repository.
* Public agent repositories appear in search results.
* Private agent repositories are only visible in your tenant.
1. Click **Publish**.
1. You can also publish the agent repository using the generated CLI command.
1. Click **Finish**.

Your agent repository is created in the Agent Hub.

### Settings

The settings page allows you to manage your tenants and users.

#### Tenants

Tenants represent separate spaces or organizations within the Agent Hub, each with its own repositories and users. The tenants available to you are listed under the **Tenants** tab.

Clicking the three dots (**⁝**) at the end of any record in opens a drop-down list of actions you can perform on that tenant.

* Click **Edit** to edit the tenant.
* Click **Delete** to delete the tenant.
* Click **Switch** to switch to the tenant.

You can reload the listed items by clicking the **Reload** button (**⟳**).

#### Users

The users in a tenant are listed under the **Users** tab.

Clicking the three dots (**⁝**) at the end of any record in opens a drop-down list of actions you can perform on that tenant.

* Click **Edit** to edit the user's role.
* Click **Delete** to delete the user.

You can reload the listed items by clicking the **Reload** button (**⟳**).
File renamed without changes.
File renamed without changes.
Loading