Skip to main content

Official Neuronum Tools Library

Project description

Neuronum

Neuronum Tools Library

Website Documentation PyPI Version
Python Version License


Getting Started

In this brief getting started guide, you will:


About Neuronum Tools

Neuronum Tools serve as plug and play Servers/Applications that allow ceLLai to connect to external data sources and systems. Neuronum Tools follow standardized MCP (Model Context Protocol) guidelines.

Requirements

  • Python >= 3.8

Connect To Neuronum

Installation (optional but recommended: create a virtual environment)

pip install neuronum

Create your Cell (your secure identity):

neuronum create-cell

or

Connect an existing Cell (your secure identity):

neuronum connect-cell

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

To remove a tool from Neuronum:

neuronum delete-tool

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

neuronum-12.0.1.tar.gz (11.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

neuronum-12.0.1-py3-none-any.whl (10.8 kB view details)

Uploaded Python 3

File details

Details for the file neuronum-12.0.1.tar.gz.

File metadata

  • Download URL: neuronum-12.0.1.tar.gz
  • Upload date:
  • Size: 11.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for neuronum-12.0.1.tar.gz
Algorithm Hash digest
SHA256 d87b332531ef9d1da98942643c0acfd94bdce62677eaa752b3fb7568839f3134
MD5 4d70915144b4af644cc4a6a99448c19e
BLAKE2b-256 b50135b3ca70333e03ddc9ade4b097f4cfb2e213626f09e7f3fabd46398561d3

See more details on using hashes here.

File details

Details for the file neuronum-12.0.1-py3-none-any.whl.

File metadata

  • Download URL: neuronum-12.0.1-py3-none-any.whl
  • Upload date:
  • Size: 10.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for neuronum-12.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 72ec73f0ae4834dd952ddc17d31c63a1c4e20e5c633b744020c6e40e46cdfdcb
MD5 26af3b6581c6294b23faa8744e1b0eba
BLAKE2b-256 d4abb0dbf9ecdca894f39227bfbaa5a0c1d517a603bed64b428b7542a07555e6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page