neuronum 12.3.0

Neuronum SDK

Neuronum SDK

---

A Getting Started into the Neuronum SDK

In this brief getting started guide, you will:

• Learn about the Neuronum SDK
• Connect your ID to Neuronum
• Create & Manage A custom Tool
• Integrate the API to call your Agent

---

About Neuronum SDK

The Neuronum SDK is the official Python ecosystem to develop and publish custom Tools and lets you integrate the Neuronum API to interact with your Agent from existing projects

Requirements

• Python >= 3.8

---

Connect To Neuronum

Installation

pip install neuronum

Connect an existing Cell (your secure identity)

neuronum connect-cell

---

Create A Tool

Neuronum Tools are MCP-compliant (Model Context Protocol ) plugins that extend your Agent's functionality, enabling it to interact with external data sources and systems.

Initialize a Tool

neuronum init-tool

You will be prompted to enter a tool name and description (e.g., "Test Tool" and "A simple test tool"). This will create a new folder named using the format: Tool Name_ToolID (e.g., Test Tool_019ac60e-cccc-7af5-b087-f6fcf1ba1299)

This folder will contain 2 files:

1. tool.config - Configuration and metadata for your tool
2. tool.py - Your Tool/MCP server implementation

Example tool.config:

{
  "tool_meta": {
    "tool_id": "019ac60e-cccc-7af5-b087-f6fcf1ba1299",
    "version": "1.0.0",
    "name": "Test Tool",
    "description": "A simple test tool",
    "audience": "private",
    "logo": "https://neuronum.net/static/logo_new.png"
  },
  "legals": {
    "terms": "https://url_to_your/terms",
    "privacy_policy": "https://url_to_your/privacy_policy"
  },
  "requirements": [],
  "variables": []
}

Example tool.py:

from mcp.server.fastmcp import FastMCP

# Create server instance
mcp = FastMCP("simple-example")

@mcp.tool()
def echo(message: str) -> str:
    """Echo back a message"""
    return f"Echo: {message}"

if __name__ == "__main__":
    mcp.run()
    asyncio.run(main())

Update a Tool

After modifying your tool.config or tool.py files, submit the updates using:

neuronum update-tool

Delete a Tool

neuronum delete-tool

Integrate Neuronum API

Send a simple prompt to your Agent

import asyncio
from neuronum import Cell

async def main():
    
    async with Cell() as cell: 

        # Build the data payload
        data = {
          "type": "prompt",
          "prompt": "Explain what a black hole is in one sentence"
        }

        # Use activate_tx() if you expect a response from your Agent
        tx_response = await cell.activate_tx(data)
        print(tx_response)

if __name__ == '__main__':
    asyncio.run(main())