GUI URL | Patterns for Agentic Tools

arcade.dev/patterns

Context

Tools that create or retrieve resources with web UIs.

Problem

Users often want to see results in the application's native interface.

Solution

Include GUI URLs in responses:
- View URL: Link to see the resource
- Edit URL: Link to modify (if applicable)
- Dashboard URL: Link to overview

Examples

Python

@tool
def create_document(
    title: str,
    content: str
) -> DocumentResult:
    """Create a document."""
    doc = docs_api.create(title, content)
    return DocumentResult(
        document_id=doc.id,
        title=doc.title,
        view_url=f"https://docs.example.com/d/{doc.id}",
        edit_url=f"https://docs.example.com/d/{doc.id}/edit"
    )

Considerations

Use deep links to specific resources
Include both view and edit URLs when relevant
Consider URL expiration for sensitive resources

Related Patterns

More in Tool Output

Response Shaper

Transform raw API responses into agent-friendly formats.

Token-Efficient Response

Minimize response size while preserving essential information.

Paginated Result

Handle large result sets with cursor-based pagination.

LLM-Optimized View

# GUI URL

Include links to view or edit results in a web interface.

## Category
Tool Output

## Context
Tools that create or retrieve resources with web UIs.

## Problem
Users often want to see results in the application's native interface.

## Solution
Include GUI URLs in responses:
- **View URL**: Link to see the resource
- **Edit URL**: Link to modify (if applicable)
- **Dashboard URL**: Link to overview

## Example (Python)
```python
@tool
def create_document(
    title: str,
    content: str
) -> DocumentResult:
    """Create a document."""
    doc = docs_api.create(title, content)
    return DocumentResult(
        document_id=doc.id,
        title=doc.title,
        view_url=f"https://docs.example.com/d/{doc.id}",
        edit_url=f"https://docs.example.com/d/{doc.id}/edit"
    )
```

## Considerations
- Use deep links to specific resources
- Include both view and edit URLs when relevant
- Consider URL expiration for sensitive resources

## Related Patterns
- response-shaper
- tool

---
Source: https://arcade.dev/patterns/gui-url