Skip to main content

Open Source Personality Profiling System based on MCP Protocol

Project description

OpenSoul MCP

When was the last time you truly listened to yourself?

OpenSoul is an open-source personality profiling system. It records every disagreement with AI, every moment of silence, every hesitation—not to monitor you, but to help you see yourself.

PyPI License: MIT Python 3.11+ MCP Protocol


Quick Install

Option 1: pip Install (Recommended)

pip install opensoul-mcp
opensoul-mcp install

Done. Restart Claude Code and you're ready to go.

opensoul-mcp install automatically:

  • Creates config directory ~/.opensoul/ and data directory ~/.opensoul/data/
  • Generates a random API key
  • Registers OpenSoul in Claude Code's MCP settings (~/.claude/settings.json)

Option 2: Install from Source

git clone https://github.com/OpenSoul-MCP/opensoul-mcp.git
cd opensoul-mcp
pip install -e .
opensoul-mcp install

Option 3: Manual Configuration (No pip)

git clone https://github.com/OpenSoul-MCP/opensoul-mcp.git
cd opensoul-mcp
pip install -r requirements.txt

Then edit ~/.claude/settings.json:

{
  "mcpServers": {
    "opensoul": {
      "command": "python3",
      "args": ["/your/path/opensoul-mcp/src/opensoul_mcp/server.py"]
    }
  }
}

Optional: Semantic Search

Install Ollama and pull the embedding model to enable semantic search:

ollama pull bge-m3

OpenSoul works without Ollama—search will fall back to keyword matching.


Verify Installation

After restarting Claude Code, say to Claude:

Record a soul fragment:
- Context: Choosing between job offers
- AI suggestion: Pick the high-paying one
- My choice: Choose the one with growth potential
- Reason: Learning matters more than money at this stage

If Claude calls record_soul and returns results, installation is successful.

Other commands:

opensoul-mcp version   # Check version
opensoul-mcp run       # Start MCP server manually (for debugging)

Why OpenSoul?

Scenario Pain Point What OpenSoul Does
Decision Review "Why do I always regret my choices?" Records AI suggestions vs your choices to discover decision patterns
Emotion Tracking "I don't know why I suddenly broke down" 7-dimensional emotion coordinates to find hidden stress sources
Self-Dialogue "I want to understand myself better" Continuous recording builds a personality profile—not labels, but a flowing self

Core Capabilities

Capability Description
40+ MCP Tools Full coverage for recording, querying, analysis, and personality assessment
INSERT-only Architecture Append-only, no modifications, complete history preserved
SHA256 Hash Chain Each record cryptographically linked, tamper-proof
Semantic Search Vector search + keyword matching (requires Ollama configuration)
Personality Profile 7-dimensional personality model analysis
Emotion Coordinates Valence, intensity, duration, trigger source
Persona Card System 60-question three-tier personality assessment (shares question bank with copywriting system)
Relationship Network Record interpersonal relationships and interaction events
Narrative Engine Guided deep conversations, layer-by-layer exploration
Local-First SQLite storage, data never leaves your computer

Tech Stack

  • Protocol: MCP (Model Context Protocol)
  • Language: Python 3.11+
  • Database: SQLite (WAL mode)
  • Vectors: bge-m3 via Ollama (optional, works offline)
  • Full-Text Search: FTS5
  • Data Integrity: SHA256 Hash Chain

Documentation


License

MIT License - Free to use, modify, and commercialize. Just retain the copyright notice.


OpenSoul was created by Butterfly Brother. Domain: opensoul.top

Every thought that goes unrecorded is a tiny act of forgetting.

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

opensoul_mcp-0.3.1.tar.gz (78.7 kB view details)

Uploaded Source

Built Distribution

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

opensoul_mcp-0.3.1-py3-none-any.whl (81.0 kB view details)

Uploaded Python 3

File details

Details for the file opensoul_mcp-0.3.1.tar.gz.

File metadata

  • Download URL: opensoul_mcp-0.3.1.tar.gz
  • Upload date:
  • Size: 78.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for opensoul_mcp-0.3.1.tar.gz
Algorithm Hash digest
SHA256 fea9c6bc38104dfaf56fb084bf9b39984ca0f25fb540ee138220ffda8c5d678c
MD5 2e92984c267bf19f32f624f766f22465
BLAKE2b-256 d44b56baef4e7c50bf92f6e0f12cfe3b192130fa1b5072c18bf2de886b27dab4

See more details on using hashes here.

File details

Details for the file opensoul_mcp-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: opensoul_mcp-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 81.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for opensoul_mcp-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2dd95f249bd9342022f17fcc4112255b74dbce2d3cc55fca46e3d5621f155a4a
MD5 fd668c182287c7e713183f32bdd34b53
BLAKE2b-256 84133ca02e240640389b2ab0e3c13ba5f7bce8d538cd81f46058abfa05ba957c

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