SDK Workflow

Initialize a project:

ncp init my-agent-project
cd my-agent-project

Common CLI commands:

ncp validate .              # Validate project structure and config
ncp package .               # Package agent into .ncp file
ncp authenticate            # Authenticate with the NCP platform
ncp deploy my-agent.ncp     # Deploy agent to the platform
ncp playground              # Test agent interactively
ncp remove --agent <name>   # Remove a deployed agent

Development best practices:

  1. Start simple, build a single tool and verify it works before adding complexity

  2. Test locally with ncp playground before deploying

  3. Use type hints and docstrings - the LLM relies on them

  4. Handle errors within tools so the agent degrades gracefully

  5. Pin dependency versions in requirements.txt for reproducible builds

Deploying on NCP:

Once packaged, upload the .ncp file through the NCP platform UI (Preferences → Agents → Upload Agent) or deploy via CLI using ncp deploy.

Agents submitted by users with the Submit Agents role go through administrator approval before becoming available platform-wide.

Last updated