Getting Started

Prerequisites

• Python 3.8 or higher (3.9+ recommended)

• pip package manager

• Virtual environment (included with Python 3.3+)

Platform-specific setup:

macOS:

brew install python@3.11

Linux (Ubuntu/Debian):

sudo apt update
sudo apt install python3.11 python3.11-pip python3.11-venv

Windows:

1. Download Python from python.org

2. Run the installer and check "Add Python to PATH"

3. Verify: python --version and pip --version

SDK Installation

Step 1 - Create a virtual environment:

python -m venv .venv
source .venv/bin/activate       # macOS/Linux
.venv\Scripts\activate          # Windows

Step 2 - Install the NCP SDK:

pip install ncp-sdk

Step 3 - Verify installation:

ncp --help
python -c "from ncp import Agent, tool; print('NCP SDK installed successfully!')"

Quick Verification

Create a simple test file to confirm everything is working:

# test_ncp.py
from ncp import Agent, tool

@tool
def hello_world(name: str = "World") -> str:
    """Say hello to someone."""
    return f"Hello, {name}!"

agent = Agent(
    name="TestAgent",
    description="A simple test agent",
    instructions="You are a test agent. Be helpful.",
    tools=[hello_world]
)

print("NCP SDK is working correctly!")

Run it:

python test_ncp.py