Skip to content

Commit 89d3e71

Browse files
authored
Merge pull request #35 from infobloxopen/docs/doctor-domain-readme
docs: document --domain option in doctor examples
2 parents b77ed45 + 69184da commit 89d3e71

File tree

2 files changed

+9
-7
lines changed

2 files changed

+9
-7
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ The CLI, MCP server, and examples load `.env` automatically. Set your backend, c
5555
```bash
5656
# Verify your environment is correctly configured
5757
dns-aid doctor
58+
dns-aid doctor --domain example.com # test agent discovery for your domain
5859
```
5960

6061
### Python Library
@@ -85,7 +86,7 @@ print(f"Security Score: {result.security_score}/100")
8586

8687
# Run environment diagnostics (programmatic access)
8788
from dns_aid.doctor import run_checks
88-
report = run_checks()
89+
report = run_checks(domain="example.com")
8990
print(f"{report.pass_count} passed, {report.fail_count} failed")
9091
```
9192

@@ -118,8 +119,8 @@ See the [Getting Started Guide](docs/getting-started.md#docker-playground-zero-c
118119
dns-aid init
119120

120121
# Diagnose environment (Python, deps, DNS, backends, .env)
121-
# Checks for updates, SVCB support, agent discovery, and more
122-
dns-aid doctor
122+
# Use --domain to test agent discovery for your domain
123+
dns-aid doctor --domain example.com
123124

124125
# Publish an agent to DNS
125126
dns-aid publish \
@@ -268,7 +269,7 @@ dns-aid-mcp --transport http --port 8000
268269
| `delete_agent_from_dns` | Remove an agent from DNS (auto-updates index) |
269270
| `list_agent_index` | List agents in domain's index record |
270271
| `sync_agent_index` | Sync index with actual DNS records |
271-
| `diagnose_environment` | Run environment diagnostics (deps, DNS, backends) |
272+
| `diagnose_environment` | Run environment diagnostics (deps, DNS, backends). Optional `domain` param for discovery check |
272273

273274
### Claude Desktop Integration
274275

@@ -698,7 +699,7 @@ Infoblox NIOS is the on-premise DDI platform with WAPI (Web API). DNS-AID create
698699

699700
3. **Verify zone access and publish**:
700701
```bash
701-
dns-aid doctor # Check NIOS credentials
702+
dns-aid doctor --domain example.com # Check NIOS credentials + discovery
702703
dns-aid publish -n my-agent -d example.com -p mcp -e mcp.example.com --backend nios
703704
```
704705

docs/getting-started.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -141,9 +141,10 @@ Run the built-in diagnostics to check that everything is configured correctly:
141141

142142
```bash
143143
dns-aid doctor
144+
dns-aid doctor --domain example.com # also test agent discovery for your domain
144145
```
145146

146-
This checks Python version, core dependencies, DNS resolution, backend credentials, optional features (MCP, JWS, OpenTelemetry), and `.env` configuration. Each check shows ✓ (pass), ✗ (fail), or ○ (warning/optional).
147+
This checks Python version, core dependencies, DNS resolution, backend credentials, optional features (MCP, JWS, OpenTelemetry), and `.env` configuration. Use `--domain` (or `DNS_AID_DOCTOR_DOMAIN` env var) to test agent discovery against your domain. Each check shows ✓ (pass), ✗ (fail), or ○ (warning/optional).
147148

148149
## Quick Test (No AWS needed)
149150

@@ -324,7 +325,7 @@ export NIOS_VERIFY_SSL="false" # Set to true with valid TLS certs
324325

325326
```bash
326327
# Check NIOS credentials and connectivity
327-
dns-aid doctor
328+
dns-aid doctor --domain example.com
328329
```
329330

330331
### 3. Set Test Zone

0 commit comments

Comments
 (0)