Skip to main content

The Self-Evolving Cognitive Agent Framework

Project description

Python 3.12+ MIT License Phase 4 Architecture

🧠 NeuralClaw

The Self-Evolving Cognitive Agent Framework
Perceive · Remember · Reason · Evolve · Act

A next-generation autonomous agent that introduces cognitive memory architecture,
self-evolving intelligence, and security-first design.


📖 Documentation

Comprehensive guides are available in the docs/ directory:

Guide Description
Getting Started Install, configure, first chat
Architecture Five Cortices, Neural Bus, pipeline
Channels Telegram, Discord, Slack, WhatsApp, Signal
Memory Episodic, Semantic, Procedural + Metabolism
Reasoning Fast-path → Deliberative → Reflective → Meta
Swarm & Multi-Agent Delegation, Consensus, Agent Mesh
Federation Cross-network agents, trust scoring
Skills Builtins, Marketplace, Economy
Security Threat screening, sandbox, audit
Configuration TOML config, env vars, keychain
API Reference Python API quick reference
Troubleshooting Common issues, debugging

✨ What Makes NeuralClaw Different

Problem in existing agents NeuralClaw's answer
Flat markdown memory Cognitive Tri-Store — Episodic + Semantic + Procedural memory with metabolism (consolidation, decay, strengthening)
Dumb reactive loops 4-Layer Reasoning — Reflexive fast-path → Deliberative → Reflective self-critique → Meta-cognitive evolution
No self-improvement Evolution Cortex — Behavioral calibration, experience distillation, automatic skill synthesis
Skill supply-chain attacks Cryptographic Marketplace — Ed25519 signing, static analysis, risk scoring
Single-channel bots 5 Channel Adapters — Telegram, Discord, Slack, WhatsApp, Signal
No security model Zero-Trust by Default — Pre-LLM threat screening, capability-based permissions, sandboxed execution

🏗️ Architecture: The Five Cortices

                          ┌──────────────────────┐
                          │     Neural Bus       │
                          │  (async pub/sub)     │
                          └──────────┬───────────┘
                                     │
       ┌─────────────┬──────────────┼──────────────┬─────────────┐
       ▼             ▼              ▼              ▼             ▼
  ┌─────────┐  ┌──────────┐  ┌──────────┐  ┌──────────┐  ┌──────────┐
  │PERCEPTION│  │  MEMORY  │  │REASONING │  │  ACTION  │  │EVOLUTION │
  │         │  │          │  │          │  │          │  │          │
  │ Intake  │  │ Episodic │  │Fast Path │  │ Sandbox  │  │Calibrator│
  │Classify │  │ Semantic │  │Deliberate│  │Capability│  │Distiller │
  │ Threat  │  │Procedural│  │Reflective│  │  Audit   │  │Synthesize│
  │ Screen  │  │Metabolism│  │          │  │          │  │          │
  └─────────┘  └──────────┘  └──────────┘  └──────────┘  └──────────┘

Every cortex communicates through the Neural Bus — an asynchronous event-driven backbone with full reasoning trace telemetry.


🚀 Quick Start

Prerequisites

  • Python 3.12+
  • At least one LLM provider (OpenAI, Anthropic, OpenRouter, or local Ollama)

Installation

# Install from PyPI
pip install neuralclaw

# Or install with all channel adapters
pip install neuralclaw[all-channels]

# Or install from source for development
git clone https://github.com/placeparks/neuralclaw.git
cd neuralclaw
pip install -e ".[dev]"

Setup

# Run the interactive setup wizard — configures LLM providers & stores keys securely
neuralclaw init

# Configure messaging channels (Telegram, Discord, Slack, WhatsApp, Signal)
neuralclaw channels setup

Usage

# Interactive terminal chat
neuralclaw chat

# Start the full gateway with all configured channels
neuralclaw gateway

# Check configuration and status
neuralclaw status

# View configured channels
neuralclaw channels list

🔑 LLM Provider Setup

NeuralClaw supports multiple LLM providers with automatic fallback routing:

Provider Model Setup
OpenAI GPT-4o, GPT-4o-mini API key from platform.openai.com
Anthropic Claude 3.5 Sonnet API key from console.anthropic.com
OpenRouter Multi-model access API key from openrouter.ai
Local (Ollama) Llama 3, Mistral, etc. No key needed — runs on localhost:11434

All API keys are stored in your OS keychain (Windows Credential Store / macOS Keychain / Linux Secret Service) — never in plaintext config files.


📡 Channel Adapters

Channel Method Dependencies
Telegram Bot API via python-telegram-bot Token from @BotFather
Discord Bot via discord.py Token from Developer Portal
Slack Socket Mode via slack-bolt Bot + App tokens
WhatsApp whatsapp-web.js Node.js bridge Node.js 18+ required
Signal signal-cli JSON-RPC bridge signal-cli installed
# Interactive guided setup for all channels
neuralclaw channels setup

🧬 Intelligence Layer (Phase 2)

Memory Metabolism

Memories have a biological lifecycle — they aren't just appended:

Formation → Consolidation → Strengthening/Decay → Retrieval → Reconsolidation
  • Consolidation — Repeated episodic events merge into semantic knowledge
  • Strengthening — Frequently accessed memories gain importance
  • Decay — Stale, unused memories gradually lose relevance
  • Pruning — Very low-importance memories are archived

Reflective Reasoning

Complex queries trigger multi-step planning with self-critique:

Decompose → Execute sub-tasks → Self-critique → Revise plan → Synthesize answer

Evolution Cortex

Module Function
Calibrator Learns your style preferences (formality, verbosity, emoji) from corrections and interaction patterns
Distiller Extracts recurring patterns from episodes → semantic facts + procedural workflows
Synthesizer Auto-generates new skills from repeated task failures via LLM code generation + sandbox testing

Skill Marketplace

from neuralclaw.skills.marketplace import SkillMarketplace

mp = SkillMarketplace()
pkg, findings = mp.publish("my_skill", "1.0", "author", "desc", code, private_key)
# Static analysis scans for: shell exec, network exfil, path traversal, obfuscation
# Risk score: 0.0 (safe) → 1.0 (dangerous)

📁 Project Structure

neuralclaw/
├── bus/                    # Neural Bus (async event backbone)
│   ├── neural_bus.py       #   Event types, pub/sub, correlation
│   └── telemetry.py        #   Reasoning trace logging
├── channels/               # Channel Adapters
│   ├── protocol.py         #   Adapter interface
│   ├── telegram.py         #   Telegram bot
│   ├── discord_adapter.py  #   Discord bot
│   ├── slack.py            #   Slack (Socket Mode)
│   ├── whatsapp.py         #   WhatsApp (web.js bridge)
│   └── signal_adapter.py   #   Signal (signal-cli bridge)
├── cortex/                 # Cognitive Cortices
│   ├── perception/         #   Intake, classifier, threat screen
│   ├── memory/             #   Episodic, semantic, procedural, metabolism
│   ├── reasoning/          #   Fast-path, deliberative, reflective
│   ├── action/             #   Sandbox, capabilities, policy, network, audit
│   └── evolution/          #   Calibrator, distiller, synthesizer
├── providers/              # LLM Provider Abstraction
│   ├── router.py           #   Multi-provider routing + fallback
│   ├── openai.py           #   OpenAI connector
│   ├── anthropic.py        #   Anthropic connector
│   ├── openrouter.py       #   OpenRouter connector
│   └── local.py            #   Ollama / local models
├── skills/                 # Skill Framework
│   ├── registry.py         #   Discovery and loading
│   ├── manifest.py         #   Skill declarations
│   ├── marketplace.py      #   Signed distribution + static analysis
│   └── builtins/           #   Web search, file ops, code exec, calendar
├── cli.py                  # Rich-powered CLI
├── config.py               # TOML config + OS keychain secrets
└── gateway.py              # Orchestration engine (the brain)

🛡️ Security Model

NeuralClaw follows a zero-trust, security-first design:

  • Pre-LLM Threat Screening — Prompt injection and social engineering detection happens before the LLM sees the message
  • Capability-Based Permissions — Skills declare required capabilities; the verifier enforces them
  • Sandboxed Execution — Code execution runs in a restricted subprocess with resource limits
  • Cryptographic Skill Verification — Marketplace skills are HMAC-signed and statically analyzed
  • OS Keychain Integration — API keys stored in Windows Credential Store / macOS Keychain, never in files
  • Audit Logging — Every action is logged with full trace for accountability

🐝 Swarm Intelligence (Phase 3)

Delegation Chains

Agents can delegate sub-tasks to specialists with full context preservation and provenance tracking:

from neuralclaw.swarm.delegation import DelegationChain, DelegationContext

chain = DelegationChain()
ctx = DelegationContext(task_description="Research competitor pricing", max_steps=10)
delegation_id = await chain.create("researcher", ctx)
# ... sub-agent works ...
await chain.complete(delegation_id, result="Found 3 competitors", confidence=0.85)

Consensus Protocol

Multiple agents can vote on high-stakes decisions:

from neuralclaw.swarm.consensus import ConsensusProtocol, ConsensusMode

consensus = ConsensusProtocol(chain)
# Supports: MAJORITY, UNANIMOUS, WEIGHTED, QUORUM

Agent Mesh

A2A-compatible agent discovery and communication:

neuralclaw swarm status    # View registered agents
neuralclaw swarm agents    # List capabilities

Web Dashboard

Live monitoring dashboard with reasoning traces, memory stats, and swarm visualization:

neuralclaw dashboard       # Open at http://localhost:8099

🌐 Federation (Phase 4)

Agents can discover and communicate across network boundaries:

from neuralclaw.swarm.federation import FederationProtocol

fed = FederationProtocol(node_name="my-agent", port=8100)
await fed.start()                                 # Start federation server
await fed.join_federation("http://peer:8100")      # Connect to another agent
await fed.send_message(node_id, "Analyze this")    # Send cross-network task

Marketplace Economy

Credit-based economy with usage tracking, ratings, and leaderboards:

from neuralclaw.skills.economy import SkillEconomy

econ = SkillEconomy()
econ.register_author("mirac", "Mirac")
econ.register_skill("web_search", "mirac")
econ.record_usage("web_search", user_id="u1", success=True)
econ.rate_skill("web_search", rater_id="u1", score=4.5, review="Great!")
print(econ.get_trending())

Benchmarks

# Run the full benchmark suite
neuralclaw benchmark

# Run a specific category
neuralclaw benchmark --category security

# Export results to JSON
neuralclaw benchmark --export

🧪 Testing

# Install dev dependencies
pip install -e ".[dev]"

# Run full test suite
pytest tests/ -v

# Run Phase 2 functional tests
python test_phase2.py

# Run specific test modules
pytest tests/test_perception.py -v      # Perception + threat screening
pytest tests/test_memory.py -v          # Memory cortex
pytest tests/test_evolution_security_swarm.py -v  # Evolution, security, swarm
pytest tests/test_ssrf.py -v            # SSRF, URL validation, DNS rebinding
pytest tests/test_sandbox_policy.py -v  # Sandbox path validation, tool budgets

🗺️ Roadmap

Phase Focus Status
Phase 1 Foundation — Cortices, Bus, CLI, Providers, Skills ✅ Complete
Phase 2 Intelligence — Memory metabolism, reflective reasoning, evolution cortex, marketplace ✅ Complete
Phase 3 Swarm — Multi-agent delegation, consensus protocols, agent mesh, web dashboard ✅ Complete
Phase 4 Domination — Federation, marketplace economy, benchmarks, PyPI publishing ✅ Complete

📄 License

MIT License — see LICENSE for details.


Built with 🧠 by MiracCardify / Claw Club

Project details


Download files

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

Source Distribution

neuralclaw-0.4.4.tar.gz (146.0 kB view details)

Uploaded Source

Built Distribution

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

neuralclaw-0.4.4-py3-none-any.whl (163.0 kB view details)

Uploaded Python 3

File details

Details for the file neuralclaw-0.4.4.tar.gz.

File metadata

  • Download URL: neuralclaw-0.4.4.tar.gz
  • Upload date:
  • Size: 146.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for neuralclaw-0.4.4.tar.gz
Algorithm Hash digest
SHA256 f1ad552648a76881659d12da62d8a4481d8b2e4bb26ac4aaf8b9c602c512191c
MD5 4d57bb1f46d7ea1c0394e03a45cd962e
BLAKE2b-256 b6fb062008ad874d3e9035d87538dd2762fabc3c49126112a8a866b8f53c8d08

See more details on using hashes here.

File details

Details for the file neuralclaw-0.4.4-py3-none-any.whl.

File metadata

  • Download URL: neuralclaw-0.4.4-py3-none-any.whl
  • Upload date:
  • Size: 163.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for neuralclaw-0.4.4-py3-none-any.whl
Algorithm Hash digest
SHA256 aef513c103c1694522b0dd6c0e42364cfaa141b226a2eaaab26a86101c441e2b
MD5 c8654c0b755b16da56da29dcc6cccc5a
BLAKE2b-256 71853bb7e9e3e2d829678ee50d4c324d00ad0871ea59038184d31dcf99e0f9ac

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