Skip to main content

An AI agent that diagnoses network connectivity issues using OpenAI's Responses API

Project description

Connectivity Agent

A small demonstration project showing how to build a multi-tool AI Agent using OpenAI’s Responses API. Although intended as an example, it also works amazingly well for network connectivity checking.

Overview

The agent runs in a terminal. It chooses which tools to run for your query, interprets their output, and explain results in plain language.

The included tools are:

  • ping
  • curl
  • ports
  • tracert
  • nslookup
  • ipconfig
  • routing_table

Adding another tool requires only:

  1. A Python function that performs the task
  2. A brief structured description so the agent knows how to call it

Why This Example Might Be Useful

If you're learning the Responses API or experimenting with AI agents that use multiple tools, this example shows a simple pattern without extra framework code. The source is in a single file.

Example Queries

Basic Connectivity >> How is the connection to google?

Comprehensive Analysis >> Describe the connectivity to www.amazon.com. Be exhaustive.

Performance Comparison >> Compare response times between AWS on the East and West coast.

DNS Troubleshooting >> I can't reach example.com. Is it a DNS problem?

Local Network Diagnostics >> Show me my current network configuration and default gateway.

Port Analysis >> What services are currently listening on my machine?

Route Investigation >> Why might packets to cloudflare.com be taking an unusual path?

Multi-Protocol Testing >> Can I reach github.com? Check both ping and HTTP connectivity.

Security Assessment >> Are there any unexpected connections to external IP addresses?

Network Path Optimization >> Which endpoint has better routing from my location: https://www.nasa.gov or https://www.esa.int ?

Requirements

  • Python 3.10 or higher
  • OpenAI API Key

Installation

Installing from PyPI

Once published, you can install the package directly:

pip install connectivity-agent

Installing from Source

  1. Clone the repository:
git clone https://github.com/brocla/connectivity_agent.git
cd connectivity_agent
  1. Install the package:
pip install -e .

Or install the required dependencies manually:

pip install openai>=2.8.0

API Key Setup

The Connectivity Agent requires an OpenAI API key to function. You can obtain an API key from OpenAI's platform.

Setting Up Your API Key

You have two options for providing your API key:

Option 1: Environment Variable (Recommended)

Set the OPENAI_API_KEY environment variable:

On Windows:

setx OPENAI_API_KEY "your-api-key-here"

On Linux/Mac:

export OPENAI_API_KEY="your-api-key-here"

To make it permanent on Linux/Mac, add the export command to your ~/.bashrc or ~/.zshrc file.

Option 2: Direct Configuration

The OpenAI Python client will automatically look for the API key in the environment variable. Alternatively, you can modify the code to pass the key directly (not recommended for security reasons).

Usage

After installation and API key setup, run the agent:

If installed via pip:

connectivity-agent

If running from source:

python connectivity_agent.py

The agent will start an interactive REPL where you can ask connectivity-related questions.

Kudos

Thanks to Thomas Ptacek for his article You Should Write an Agent

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

connectivity_agent-0.1.3.tar.gz (6.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

connectivity_agent-0.1.3-py3-none-any.whl (7.3 kB view details)

Uploaded Python 3

File details

Details for the file connectivity_agent-0.1.3.tar.gz.

File metadata

  • Download URL: connectivity_agent-0.1.3.tar.gz
  • Upload date:
  • Size: 6.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.0

File hashes

Hashes for connectivity_agent-0.1.3.tar.gz
Algorithm Hash digest
SHA256 ae43fcd02fe35d1fb977d990fbf1c8cc8058c4592129a2f5b9057aeb022b0638
MD5 a0c62bd62205bd593e0bac4fd65c620f
BLAKE2b-256 3e3f5994474c95f1a524b1010683f4788f746ab7bedba2446e0cbeca5cff3c12

See more details on using hashes here.

File details

Details for the file connectivity_agent-0.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for connectivity_agent-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 cbe4794be905ef75560cc3e651ff4f417f141f9c49989fd209bcacc42ef209be
MD5 4a268adaa29431b2c6220623cc64ddf5
BLAKE2b-256 97d4fe1c823bd8f308b13bc6b77ac674e271537ca6e4c4dc7c2854035114e21a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page