Skip to content
Merged
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
10 changes: 10 additions & 0 deletions docs/pyagentspec/source/_components/all_components.json
Original file line number Diff line number Diff line change
Expand Up @@ -275,5 +275,15 @@
{"path": "pyagentspec.a2aagent.A2AConnectionConfig"},
{"path": "pyagentspec.a2aagent.A2ASessionParameters"}
]
},
{
"name": "Adapters",
"path": "adapters",
"classes": [
{"path": "pyagentspec.adapters.autogen.AgentSpecExporter"},
{"path": "pyagentspec.adapters.autogen.AgentSpecLoader"},
{"path": "pyagentspec.adapters.langgraph.AgentSpecExporter"},
{"path": "pyagentspec.adapters.langgraph.AgentSpecLoader"}
]
}
]
4 changes: 4 additions & 0 deletions docs/pyagentspec/source/_static/icons/agui-icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
26 changes: 18 additions & 8 deletions docs/pyagentspec/source/agentspec/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,23 @@ or create them from object representations with the assurance of conformance to

You can download the Agent Spec technical report at the following :download:`link <../_static/agentspec_technical_report.pdf>`.

You can also find the nightly version of the Agent Spec language specification
with all the latest updates at :ref:`this link<agentspecspec_nightly>`.
.. only:: stable

.. toctree::
:maxdepth: 2
.. toctree::
:maxdepth: 2

Introduction, motivation & vision <intro_and_motivation>
Language specification (v25.4.1) <language_spec_25_4_1>
Positioning in the agentic ecosystem <positioning>
Tracing <tracing>
Introduction, motivation & vision <intro_and_motivation>
Language specification (v25.4.1) <language_spec_25_4_1>
Positioning in the agentic ecosystem <positioning>
Tracing <tracing>

.. only:: dev

.. toctree::
:maxdepth: 2

Introduction, motivation & vision <intro_and_motivation>
Language specification (v25.4.1) <language_spec_25_4_1>
Language specification (under development) <language_spec_nightly>
Positioning in the agentic ecosystem <positioning>
Tracing <tracing>
18 changes: 13 additions & 5 deletions docs/pyagentspec/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,6 @@
with open(Path(__file__).parents[3] / "VERSION", "r") as f:
version_file = f.read().strip()

# The IDE complains, but the tags set exists
# We add stable as current version, we might add the version switch in the future
tags.add("stable") # type: ignore

# The full version, including alpha/beta/rc tags.
release = pyagentspec.__version__

Expand All @@ -57,6 +53,13 @@
else:
docs_version = stable_release

# The IDE complains, but the tags set exists
# We add stable as current version, we might add the version switch in the future
if docs_version == "dev":
tags.add("dev") # type: ignore
else:
tags.add("stable") # type: ignore

# -- General configuration ---------------------------------------------------

# Add any Sphinx extension module names here, as strings. They can be
Expand All @@ -79,6 +82,11 @@
"sphinx_design",
]

if docs_version == "dev":
language_spec_file = "language_spec_nightly"
else:
language_spec_file = f"language_spec_{docs_version.replace('.', '_')}"

# Set the variables that should be replaced in the substitution-extensions directives
rst_prolog = f"""
.. |release| replace:: {release}
Expand Down Expand Up @@ -128,7 +136,7 @@
autodoc_typehints = "description"

# Redirects
rediraffe_redirects = {"agentspec/language_spec.rst": "agentspec/language_spec_25_4_1.rst"}
rediraffe_redirects = {"agentspec/language_spec.rst": f"agentspec/{language_spec_file}.rst"}


# -- Options for HTML output -------------------------------------------------
Expand Down
16 changes: 16 additions & 0 deletions docs/pyagentspec/source/ecosystem/collaborations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ Agent Spec Collaborations
.. |agntcy-icon| image:: ../_static/icons/agntcy-icon.svg
:width: 200px

.. |agui-icon| image:: ../_static/icons/agui-icon.svg
:width: 200px


Open Agent Specification is partnering with leading open-source AI Agent initiatives to advance
new frontiers like **deep observability**, **autonomous agent discovery**, and standardized,
Expand All @@ -30,3 +33,16 @@ event-driven **UI interactions** across every surface.
instantiate new agents with minimal effort.

:bdg-success:`agent discovery` :bdg-info:`agent deployment`


.. grid-item-card:: |agui-icon|
:link: https://docs.ag-ui.com/introduction
:link-alt: AG-UI CopilotKit integration with Agent Spec

**AG-UI**

The integration of AG-UI with Open Agent Spec allows developers to easily
connect any AG-UI-compatible frontend with Agent Spec, enabling users to
load any Agent Spec config file, choosing a supported runtime to execute it.

:bdg-success:`agentic frontends`
62 changes: 50 additions & 12 deletions docs/pyagentspec/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,28 +3,66 @@
Installation
============

You can find all versions and supported platforms of |project| in the :package_index:`\ `.
.. only:: stable

To install version |package_name| |stable_release|, run:
You can find all versions and supported platforms of |project| in the :package_index:`\ `.

.. code-block:: bash
:substitutions:
For example, if you want to install |package_name| |stable_release|:

.. code-block:: bash
:substitutions:

pip install "|package_name|==|stable_release|"

Installing with ``pip`` pulls prebuilt binary wheels on supported platforms.

.. only:: builder_html

pip install "|package_name|==|stable_release|"
The list below shows the package versions used in the CI environment, with Business Approval requests filed for each as part of the release process.
:download:`constraints.txt <../../../pyagentspec/constraints/constraints.txt>`

Installing with ``pip`` pulls prebuilt binary wheels on supported platforms.
If you want to install |project| with exactly these package versions, download the file and run:

.. only:: builder_html
.. code-block:: bash
:substitutions:

pip install "|package_name|==|stable_release|" -c constraints.txt

.. only:: dev

1. Clone the `repository <https://github.com/oracle/agent-spec>`_.

.. code-block:: bash
:substitutions:

git clone git@github.com:oracle/agent-spec.git

.. tip::
If you face any problem, check with the Agent Spec team.

Next, install PyAgentSpec directly from source.

1. Create a fresh Python environment for building and running Agent Spec assistants:

.. code-block:: bash
:substitutions:

python3.10 -m venv <venv_name>
source <venv_name>/bin/activate

2. Move to the *agent-spec/pyagentspec* directory:

.. code-block:: bash
:substitutions:

The list of package versions used in the internal CI is available at:
:download:`constraints.txt <../../../pyagentspec/constraints/constraints.txt>`
cd agent-spec/pyagentspec

To install |project| using these exact versions, download the file and run:
3. Install ``pyagentspec``:

.. code-block:: bash
:substitutions:
:substitutions:

pip install "|package_name|==|stable_release|" -c constraints.txt
bash install-dev.sh

Extra dependencies
------------------
Expand Down