SONiC Dump Analysis Agent

An NCP AI agent project.

Project Structure


ZendeskAnalysisAgent/
├── ncp.toml              # Project configuration
├── requirements.txt      # Python dependencies
├── apt-requirements.txt  # System dependencies (optional)
├── agents/               # Agent definitions
│   └── main_agent.py    # Main agent entry point
└── tools/                # Custom tools (optional)
    └── __init__.py

Quick Start

1. Authenticate with Platform

First, authenticate with your NCP platform:


ncp authenticate

You’ll be prompted for:

Platform URL (e.g., https://ncp.example.com)
Username
Password

Credentials are saved to ncp.toml for future commands.

2. Validate Project

Validate your agent configuration:


ncp validate .

This checks:

ncp.toml syntax and structure
Agent definitions and imports
Tool implementations
Dependencies

3. Package Agent

Create a deployment package:


ncp package .

Creates ZendeskAnalysisAgent.ncp containing all agent files and dependencies.

4. Deploy Agent

Deploy to the platform:


# First deployment
ncp deploy ZendeskAnalysisAgent.ncp
 
# Update existing agent
ncp deploy ZendeskAnalysisAgent.ncp --update

The --update flag automatically extracts the agent name from the package.

5. Test in Playground

Test your agent interactively:


ncp playground --agent ZendeskAnalysisAgent
 
# Show tool calls and results
ncp playground --agent ZendeskAnalysisAgent --show-tools

Exit playground with Ctrl+C.

Managing Agents

List Deployed Agents

View all your deployed agents:


ncp list

Shows a table with agent names, versions, and deployment dates.

Remove Agent

Remove an agent from the platform:


ncp remove --agent ZendeskAnalysisAgent

You’ll be prompted to confirm before removal.

Development Workflow

Typical Development Cycle

Make changes to your agent code
Validate - ncp validate .
Package - ncp package .
Deploy/Update - ncp deploy ZendeskAnalysisAgent.ncp --update
Test - ncp playground --agent ZendeskAnalysisAgent
Iterate - Repeat steps 1-5

Adding Custom Tools

Create tools in your agent file or in tools/:


from ncp import tool
 
@tool
def calculate_sum(a: int, b: int) -> int:
    """Add two numbers together.
    
    Args:
        a: First number
        b: Second number
    
    Returns:
        Sum of a and b
    """
    return a + b

Then add to your agent:


from ncp import Agent
 
agent = Agent(
    name="ZendeskAnalysisAgent",
    description="Your agent description",
    instructions="Your agent instructions",
    tools=[calculate_sum],  # Add your tool here
)

Using MCP Servers

Add external tools via MCP servers:


from ncp import Agent, MCPConfig
 
agent = Agent(
    name="ZendeskAnalysisAgent",
    description="Agent with MCP tools",
    instructions="Your instructions",
    mcp_servers=[
        MCPConfig(
            command="mcp-server-fetch",
            transport_type="stdio"
        )
    ]
)

Customizing LLM Configuration

Configure generation parameters (model is set by platform):


from ncp import Agent, LLMConfig
 
agent = Agent(
    name="ZendeskAnalysisAgent",
    description="Your agent",
    instructions="Your instructions",
    llm_config=LLMConfig(
        temperature=0.7,
        max_tokens=2000,
    )
)

Note: The model, API key, and base URL are configured by the platform. You can only customize generation parameters (temperature, max_tokens, etc.).

Configuration Files

ncp.toml

Main project configuration:


[project]
name = "ZendeskAnalysisAgent"
version = "0.1.0"
description = "Your agent description"
 
[agents]
main = "agents.main_agent:agent"
 
[build]
python_version = "3.11"

requirements.txt

Python dependencies (installed automatically during deployment):


# Add your Python package dependencies here
# Example:
# requests>=2.31.0
# pandas>=2.0.0

apt-requirements.txt (Optional)

System packages (installed automatically during deployment):


# Add system dependencies here
# Example:
# ffmpeg
# poppler-utils

Troubleshooting

Authentication Issues


# Re-authenticate if credentials expire
ncp authenticate

Deployment Failures


# Check validation first
ncp validate .
 
# View deployed agents
ncp list

Platform Connection Issues

Verify the platform URL in ncp.toml under [platform] section.