# second-brain-joplin - Doramagic AI Context Pack

> Purpose: pre-work context for the user's host AI. This pack does not prove that the project has been installed, run, or validated.

## Project

- canonical_name: `jomkz/second-brain-joplin`
- capability: MCP server that turns your Joplin knowledge base into searchable memory for Claude Code and other MCP clients
- expected_user_outcome: MCP server that turns your Joplin knowledge base into searchable memory for Claude Code and other MCP clients

## Operating Boundaries

- Do not claim that the project has been installed, run, called through an API, or used on local files unless separate evidence proves it.
- Project facts must come from repo evidence, Claim Graph, or explicit source references.
- When a capability is not verified, mark it as unverified instead of completing it as fact.
- publish_status: `publishable`
- blocking_gaps: none

---

## Doramagic Context Augmentation

The following sections strengthen the repository context for a host AI. Human Manual data is a reading route, and pitfall notes become operating constraints.

## Human Manual Outline

Usage rule: this is only a reading route and salience signal, not factual authority. Concrete claims must still return to repo evidence or Claim Graph.

Host AI hard rules:
- Do not treat page titles, section order, summaries, or importance values as factual project evidence.
- When explaining the Human Manual outline, state that it is only a reading route or salience signal.
- Capability, installation, compatibility, runtime state, and risk claims must cite repo evidence, source paths, or Claim Graph.

- **Project Overview and System Architecture**: importance `high`
  - source_paths: README.md, src/second_brain_joplin/__init__.py, src/second_brain_joplin/server.py, src/second_brain_joplin/joplin_client.py, SECURITY.md
- **MCP Tools Reference**: importance `high`
  - source_paths: src/second_brain_joplin/server.py, src/second_brain_joplin/joplin_client.py, README.md
- **Development Workflow, Testing, and CI/CD**: importance `high`
  - source_paths: CONTRIBUTING.md, CHANGELOG.md, pyproject.toml, .pre-commit-config.yaml, docs/project-management.md
- **Installation, Deployment, and PyPI Release**: importance `medium`
  - source_paths: README.md, docs/install.md, docs/releasing.md, docs/notebook-structure.md, .env.example

## Repo Inspection Evidence

- repo_clone_verified: true
- repo_inspection_verified: true
- repo_commit: `5acb9908fd261a609e8c6bc37203e6872cb87c93`
- inspected_files: `README.md`, `pyproject.toml`, `uv.lock`, `docs/install.md`, `docs/notebook-structure.md`, `docs/project-management.md`, `docs/reference/second-brain-inspiration.md`, `docs/releasing.md`, `src/second_brain_joplin/__init__.py`, `src/second_brain_joplin/cli.py`, `src/second_brain_joplin/config.py`, `src/second_brain_joplin/errors.py`, `src/second_brain_joplin/joplin_client.py`, `src/second_brain_joplin/models.py`, `src/second_brain_joplin/server.py`, `src/second_brain_joplin/tools/__init__.py`, `src/second_brain_joplin/tools/read.py`, `src/second_brain_joplin/tools/write.py`

Host AI hard rules:
- Without repo_clone_verified=true, do not claim that the source code has been read.
- Without repo_inspection_verified=true, do not write README, docs, or package-file conclusions as facts.
- Without quick_start_verified=true, do not claim that the Quick Start path has run successfully.

## Doramagic Pitfall Constraints

These rules come from Doramagic discovery, validation, or compilation findings. The host AI must treat them as operating constraints, not background notes.

### Constraint 1: Security or permission risk requires verification

- Trigger: Developers should check this security_permissions risk before relying on the project: Add PR labeler workflow (actions/labeler)
- Host AI rule: Before packaging this project, run the relevant install/config/quickstart check for: Add PR labeler workflow (actions/labeler). Context: Source discussion did not expose a precise runtime context.
- Why it matters: Developers may expose sensitive permissions or credentials: Add PR labeler workflow (actions/labeler)
- Evidence: failure_mode_cluster:github_issue | https://github.com/jomkz/second-brain-joplin/issues/18
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 2: Security or permission risk requires verification

- Trigger: Developers should check this security_permissions risk before relying on the project: Set up CI pipeline (lint + test matrix)
- Host AI rule: Before packaging this project, run the relevant install/config/quickstart check for: Set up CI pipeline (lint + test matrix). Context: Observed when using python
- Why it matters: Developers may expose sensitive permissions or credentials: Set up CI pipeline (lint + test matrix)
- Evidence: failure_mode_cluster:github_issue | https://github.com/jomkz/second-brain-joplin/issues/2
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 3: Installation risk requires verification

- Trigger: Developers should check this installation risk before relying on the project: Bootstrap second-brain-joplin (v0.1)
- Host AI rule: Before packaging this project, run the relevant install/config/quickstart check for: Bootstrap second-brain-joplin (v0.1). Context: Observed when using python
- Why it matters: Developers may fail before the first successful local run: Bootstrap second-brain-joplin (v0.1)
- Evidence: failure_mode_cluster:github_issue | https://github.com/jomkz/second-brain-joplin/issues/1
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 4: Installation risk requires verification

- Trigger: Project evidence flags a installation risk. Review the linked source before relying on this workflow.
- Host AI rule: Reproduce the official install and quickstart path in an isolated environment.
- Why it matters: May increase setup, validation, or first-run risk for the user.
- Evidence: community_evidence:github | https://github.com/jomkz/second-brain-joplin/issues/1
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 5: Installation risk requires verification

- Trigger: Project evidence flags a installation risk. Review the linked source before relying on this workflow.
- Host AI rule: Reproduce the official install and quickstart path in an isolated environment.
- Why it matters: May increase setup, validation, or first-run risk for the user.
- Evidence: community_evidence:github | https://github.com/jomkz/second-brain-joplin/issues/9
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 6: Configuration risk requires verification

- Trigger: Project evidence flags a configuration risk. Review the linked source before relying on this workflow.
- Host AI rule: Reproduce the official install and quickstart path in an isolated environment.
- Why it matters: May increase setup, validation, or first-run risk for the user.
- Evidence: capability.host_targets | https://github.com/jomkz/second-brain-joplin
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 7: Configuration risk requires verification

- Trigger: Developers should check this configuration risk before relying on the project: Implement core read MCP tools (v0.2)
- Host AI rule: Before packaging this project, run the relevant install/config/quickstart check for: Implement core read MCP tools (v0.2). Context: Source discussion did not expose a precise runtime context.
- Why it matters: Developers may misconfigure credentials, environment, or host setup: Implement core read MCP tools (v0.2)
- Evidence: failure_mode_cluster:github_issue | https://github.com/jomkz/second-brain-joplin/issues/4
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 8: Configuration risk requires verification

- Trigger: Developers should check this configuration risk before relying on the project: Implement package skeleton and stubbed MCP server
- Host AI rule: Before packaging this project, run the relevant install/config/quickstart check for: Implement package skeleton and stubbed MCP server. Context: Observed when using python
- Why it matters: Developers may misconfigure credentials, environment, or host setup: Implement package skeleton and stubbed MCP server
- Evidence: failure_mode_cluster:github_issue | https://github.com/jomkz/second-brain-joplin/issues/3
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 9: Configuration risk requires verification

- Trigger: Developers should check this configuration risk before relying on the project: PyPI publish, full docs, and Joplin templates (v1.0)
- Host AI rule: Before packaging this project, run the relevant install/config/quickstart check for: PyPI publish, full docs, and Joplin templates (v1.0). Context: Observed when using windows, macos, linux
- Why it matters: Developers may misconfigure credentials, environment, or host setup: PyPI publish, full docs, and Joplin templates (v1.0)
- Evidence: failure_mode_cluster:github_issue | https://github.com/jomkz/second-brain-joplin/issues/11
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 10: Configuration risk requires verification

- Trigger: Project evidence flags a configuration risk. Review the linked source before relying on this workflow.
- Host AI rule: Reproduce the official install and quickstart path in an isolated environment.
- Why it matters: May increase setup, validation, or first-run risk for the user.
- Evidence: community_evidence:github | https://github.com/jomkz/second-brain-joplin/issues/19
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.
