# Upgrade Guides

Use this checklist whenever you bump GL AIP or deploy a new version of the AIP backend.

{% hint style="success" %}
**When to use this guide:** Plan upgrades, communicate timelines, or document migrations between AIP releases.

**Who benefits:** Release managers, platform engineers, and PMs coordinating customer rollouts.
{% endhint %}

> ℹ️ **Current versions**
>
> * AIP SDK: `0.0.10`
> * AIP Platform backend: `0.1.53`

Latest platform release notes live at <https://github.com/GDP-ADMIN/ai-agent-platform/releases>. SDK release notes are tracked in the [Changelog](https://gdplabs.gitbook.io/gl-aip/resources/changelog).

{% stepper %}
{% step %}

### Read the changelog

Capture breaking changes or behavioural updates before upgrading.
{% endstep %}

{% step %}

### Export state

Back up agents, tools, and MCP configs as JSON/YAML if you manage them manually.
{% endstep %}

{% step %}

### Update the SDK/CLI

On each machine or runner execute:

{% code title="CLI" %}

```bash
aip update
```

{% endcode %}
{% endstep %}

{% step %}

### Smoke test

Run basic checks to ensure functionality:

* `aip status`
* representative `aip agents run` / `aip tools get` commands
* `client.ping()` from a Python shell
  {% endstep %}

{% step %}

### Deploy backend changes (if applicable)

Pull the corresponding AIP release and restart services.
{% endstep %}

{% step %}

### Verify MCP and tool integrations

Run one workflow that exercises each connector you depend on.
{% endstep %}

{% step %}

### Communicate

Note the versions installed and any follow-up tasks (e.g., feature flag toggles, configuration updates).
{% endstep %}
{% endstepper %}

***

## Tips

* Keep a copy of exported agent/tool JSON in version control; it simplifies rollback and lets you diff changes across upgrades.
* Automate `aip update` via CI jobs so runners stay in sync with PyPI releases.
* When the REST API introduces new endpoints or payloads, the [REST API Reference](https://gdplabs.gitbook.io/gl-aip/resources/reference/rest-api) is updated automatically and should be consulted for schema details.

Future breaking changes will re-use this page—add concise “Before / After” code snippets when they land so the checklist stays actionable.

## Related playbooks

* [Configuration management guide](https://gdplabs.gitbook.io/gl-aip/how-to-guides/configuration-management-guide) — Export/import workflows for pre- and post-upgrade backups.
* [Automation & scripting](https://gdplabs.gitbook.io/gl-aip/how-to-guides/automation-and-scripting) — Schedule `aip update` checks and regression runs.
* [Agents guide](https://gdplabs.gitbook.io/gl-aip/how-to-guides/agents-guide) — Validate run history and streaming behaviour after upgrades.
* [Security & privacy](https://gdplabs.gitbook.io/gl-aip/how-to-guides/security-and-privacy) — Confirm PII mappings and token scopes did not regress.