Reference
CLI Reference
ncp --help # Show all available commands
ncp init <project-name> # Initialize a new agent project
ncp validate . # Validate project structure
ncp package . # Build .ncp deployment package
ncp authenticate # Authenticate with the NCP platform
ncp deploy <file>.ncp # Deploy an agent package
ncp list # List deployed agents
ncp remove --agent <name> # Remove a deployed agent
ncp playground # Platform-connected interactive testing
ncp ask "<question>" --agent <name> # Scripted, non-interactive test
ncp connectors list | info <name> # Discover data connectors
ncp agents list | info <name> # Discover platform agents
ncp onboard <file>.ncp # Onboard a custom agent (admin-only)
ncp onboard-list # List onboarded agents (admin-only)
ncp onboard-remove --agent <name> # Remove an onboarded agent (admin-only)Key Flags
package:
-o, --output <file>,--version <tag>authenticate:
--platform <url>(stores credentials in~/.ncp/credentials.toml)deploy / onboard:
--platform,--api-key,--updateplayground:
--agent,--local,--show-tools,--logs [LEVEL]ask:
--agent(required),--json,--timeout <seconds>,--platform,--api-key
SDK API Surface
Core:
Agent,tool,LLMConfig,MCPConfig,TransportTypeComposition & control:
AgentTool,handoff,AgentHooksOrchestration:
SequentialAgent,ParallelAgent,RoutingAgent,LoopAgent,StopCondition,DynamicParallelAgentMemory:
MemoryConfig,STMStrategy,MemoryPlatform runtime helpers (deployed only):
Files,Metrics,Artifacts,invoke_llm,send_status,send_contentKnowledge tools:
ncp.tools.knowledge.search.search_knowledge,ncp.tools.knowledge.peek.peek_knowledgePlatform agents:
ncp.platform.agent(<name>)Skills:
ncp.load_skill(),ncp.discover_skills()Testing:
ncp.testing.ask_agent(),ncp.testing.query_agent_async()
For field-level detail, see the Agent reference (Core Concepts) and the Advanced Features sections for memory, files, knowledge, skills, metrics, hooks, handoffs, connections, and testing.
Resources
PyPI package: https://pypi.org/project/ncp-sdk/
SDK examples: https://github.com/AvizNetworks/ncp-sdk-examples
Sample agents: https://github.com/AvizNetworks/ncp-sdk-agents
Related NCP documentation
Agent Onboarding - upload, approval workflow, and role requirements
Roles & Permissions - configuring Submit Agents and CustomAgents access
Data Connectors - connectors that agents can reference
Last updated
