Skip to content

Commit aec62f9

Browse files
committed
Merged local Gemini API project with MARM main branch
2 parents 1042f49 + dcb161e commit aec62f9

26 files changed

Lines changed: 2722 additions & 0 deletions

CHANGELOG.md

Lines changed: 139 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,139 @@
1+
# Changelog
2+
3+
## Project Files
4+
5+
- [README.md](README.md) – Core introduction and quick start for using MARM.
6+
- [FAQ.md](FAQ.md) – Answers to common questions about how and why to use MARM.
7+
- [CHANGELOG.md](CHANGELOG.md) – Tracks updates, edits, and refinements to the protocol.
8+
- [CONTRIBUTING.md](CONTRIBUTING.md) – Contribution guidelines and collaborator credits.
9+
- [DESCRIPTION.md](DESCRIPTION.md) – Protocol purpose and vision overview.
10+
- [LICENSE](LICENSE) – Terms of use for this project.
11+
- [HANDBOOK.md](HANDBOOK.md) – Full guide to MARM usage, including commands, examples, and beginner to advanced tips.
12+
- [ROADMAP.md](ROADMAP.md) – Planned features, upcoming enhancements, and related protocols under development.
13+
14+
---
15+
16+
## MARM Protocol – v1.3 Change Log
17+
All notable updates between **June 9–23, 2025** are documented below. Entries are grouped by date using collapsible dropdowns for clarity.
18+
19+
---
20+
21+
<details>
22+
<summary> June 9–13: Initial Protocol Unification (v1.2 Launch)</summary>
23+
24+
### Added
25+
- `/compile` command to generate one-line-per-entry summaries
26+
- Automatic reseed block generation for restoring context in new threads
27+
- Log schema enforcement for structured logging: `[YYYY-MM-DD | User | Intent | Outcome]`
28+
- Error handling for malformed log entries, including date autofill
29+
- `/show reasoning` command to reveal the AI’s logic path
30+
- Manual Steps Justification section added to `HANDBOOK.md`
31+
- Consolidated Examples section showing real use cases for all major commands
32+
- Clarified optional system prompt behavior (not built-in; manual only)
33+
- New session management guidance: recap every 8–10 turns using `/compile`
34+
35+
### Changed
36+
- Unified session tools into default protocol behavior
37+
- README restructured for clarity:
38+
- Quick Start moved above initiation
39+
- Core Features moved to `HANDBOOK.md`
40+
- Acknowledgment behavior clarified
41+
- Protocol one-liner updated to reflect unified design
42+
43+
### Removed
44+
- Legacy modular language and optional tool references
45+
- Confidence flag/scoring feature from all protocol outputs
46+
- All mentions of auto-save or speculative memory behavior
47+
48+
</details>
49+
50+
---
51+
52+
<details>
53+
<summary> June 14–17: Documentation Expansion and Restructuring</summary>
54+
55+
### Added
56+
- `HANDBOOK.md`: full command reference and usage guide
57+
- Collapsible section formatting for all major handbook parts (Beginner, Advanced, Examples, Quick Reference)
58+
- “Why Manual Steps Matter” rationale
59+
- Expanded Limitations section
60+
- Slash-style command formatting standard:
61+
- `/start marm`
62+
- `/log [SessionName]`
63+
- `/guarded reply`
64+
- `/show reasoning`
65+
- `/compile [SessionName] --summary`
66+
67+
### Changed
68+
- FAQ.md grouped and rewritten by category: Core Concepts, Sessions, Commands, Platform Support
69+
- README clarified and reorganized to align with handbook
70+
- Handbook structured into Beginner / Intermediate / Advanced use tiers
71+
- Emphasis on manual workflows and session recap cadence
72+
73+
### Removed
74+
- Embedded command list from README
75+
- “Back to top” anchors (due to GitHub collapsible quirks)
76+
77+
</details>
78+
79+
---
80+
81+
<details>
82+
<summary> June 18–20: Externalization and Visibility Focus</summary>
83+
84+
### Added
85+
- AI-narrated walkthrough: 15-minute audio guide embedded in README
86+
- User Feedback section (collapsible, with real screenshots)
87+
- Featured on Google badge added to README header
88+
- `CONTRIBUTING.md` and Recognition Framework
89+
- Multi-tier GitHub Discussions and onboarding entry points
90+
91+
### Changed
92+
- README focus shifted to narrative onboarding:
93+
- “What → Why → How → Proof” sequence
94+
- Replaced “Use Cases” with community-backed examples
95+
- Light marketing layer added (clear, not exaggerated)
96+
97+
</details>
98+
99+
---
100+
101+
<details>
102+
<summary> June 21: README Cleanup & Structure Pass</summary>
103+
104+
### Changed
105+
- Cleaned up main README for new-user clarity
106+
- Reordered sections: **What MARM is → Why it helps → How to use it**
107+
- Merged “Problem” and “Use Cases” into one purpose-driven section
108+
- Moved Contact, Credits, and auxiliary content to `CONTRIBUTING.md`
109+
- Simplified Quick Start block
110+
- Added audio walkthrough link with summary of included topics
111+
112+
</details>
113+
114+
---
115+
116+
<details>
117+
<summary>June 23: Protocol Expansion (v1.3 Launch)</summary>
118+
119+
### Added
120+
- `/notebook` command to save custom info in a personal library
121+
→ Guides the AI to use only trusted user-provided data, not external sources
122+
- Passive reentry prompts to resume, archive, or reset context on return
123+
- Error handling for invalid `/log` entries, including date autofill suggestions
124+
- Filter support for `/compile --fields=` to create focused summaries
125+
- “What’s New in v1.3” section added to `HANDBOOK.md`, with usage guide
126+
- Inline user guide for `/notebook` under collapsible alert block
127+
- New dropdown: “Key Info and Limitations” (moved from protocol body)
128+
129+
### Changed
130+
- “What MARM Solves” and “Why It Exists” sections updated to reflect v1.3 behavior
131+
- Activation response now includes summary and Quick Start command list
132+
- Examples revised for clarity and real-world use
133+
- AI now defaults to prioritizing `/notebook` entries over trained assumptions
134+
135+
### Removed
136+
- Key info and limitations from static protocol body (now placed in dropdown)
137+
- Redundant phrasing in command definitions and legacy guardrail notes
138+
139+
</details>

CONTRIBUTING.md

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
# Contributing to MARM
2+
3+
## Project Files
4+
5+
- [README.md](README.md) – Core introduction and quick start for using MARM.
6+
- [FAQ.md](FAQ.md) – Answers to common questions about how and why to use MARM.
7+
- [CHANGELOG.md](CHANGELOG.md) – Tracks updates, edits, and refinements to the protocol.
8+
- [CONTRIBUTING.md](CONTRIBUTING.md) – Contribution guidelines and collaborator credits.
9+
- [DESCRIPTION.md](DESCRIPTION.md) – Protocol purpose and vision overview.
10+
- [LICENSE](LICENSE) – Terms of use for this project.
11+
- [HANDBOOK.md](HANDBOOK.md) – Full guide to MARM usage, including commands, examples, and beginner to advanced tips.
12+
- [ROADMAP.md](ROADMAP.md) – Planned features, upcoming enhancements, and related protocols under development.
13+
14+
---
15+
16+
Thank you for your interest in contributing to the Memory Accurate Response Mode (MARM) Protocol. Whether you're here to test, give feedback, suggest improvements, or help evolve the framework, you're part of making something more stable and transparent in LLM interactions.
17+
18+
---
19+
20+
## How to Contribute
21+
<details>
22+
<summary>Click here to see how to Test, Suggest and Improve</summary>
23+
24+
### Test the Protocol
25+
Run MARM through your own workflows using `/log`, `/compile`, and reseed blocks.
26+
Report any drift, breakdowns, or UX issues. Especially across different LLMs like ChatGPT, Gemini, Claude, or Perplexity.
27+
28+
### Suggest Enhancements
29+
If you’ve identified friction points, architectural gaps, or ways to simplify the prompt layer, open a GitHub issue (or DM directly if we're already connected).
30+
31+
### Improve Documentation
32+
You can submit typo fixes, restructure guides, or help clarify edge-case behaviors.
33+
34+
### Developer Support (Optional)
35+
If you have Python, JSON, or LLM toolchain experience and want to help convert MARM into a working tool or plugin, reach out. I'm looking to move from protocol to product in future phases.
36+
</details>
37+
38+
---
39+
40+
## Current Contributors (Reddit Users)
41+
42+
The following users directly shaped the protocol through feedback, ideas, or early support:
43+
44+
### u/CalamityThorazine & u/CrazyCrayfish
45+
[Reddit Thread – June 9, 2025](https://www.reddit.com/r/PromptEngineering/comments/1l7jtpn/i_analyzed_150_real_ai_complaints_then_built_a/)
46+
47+
Encouraged the move from temporary hosting (e.g., Google Drive) to GitHub, improving accessibility and trust. Their early interest helped validate public release and shaped the decision to publish the protocol in a permanent, versioned repository.
48+
49+
---
50+
51+
### Reddit Contributor
52+
[Reddit Thread – June 10, 2025](https://www.reddit.com/r/PromptEngineering/comments/1l7jtpn/i_analyzed_150_real_ai_complaints_then_built_a/)
53+
54+
Provided early-stage critique and refinement feedback on memory simulation, session labeling, and user experience logic. Influenced the removal of the confidence scoring system, the creation of the `/show reasoning` command, and improvements to session lifecycle documentation.
55+
56+
---
57+
58+
### u/Deminimis_opsec
59+
[Reddit Thread – June 10, 2025](https://www.reddit.com/r/PromptEngineering/comments/1l7jtpn/i_analyzed_150_real_ai_complaints_then_built_a/)
60+
61+
Provided critical technical feedback on MARM’s limitations within non-API chat environments. Helped clarify the distinction between frontend prompt-layer protocols and backend memory architectures. Their input reinforced the importance of transparency around session scope, non-persistent memory, and the lack of backend execution in typical LLM interfaces.
62+
63+
---
64+
65+
### u/Angry_cactus
66+
[Reddit Thread – June 11, 2025](https://www.reddit.com/r/PromptEngineering/comments/1l7jtpn/i_analyzed_150_real_ai_complaints_then_built_a/)
67+
68+
Tested MARM across models and validated its performance in Gemini Pro. Provided feedback on LLM pseudo-memory behaviors, reply weighting, and the trade-offs between short-form prompts and structured memory. Their observations reinforced the session-based design choice and influenced future patch direction focused on continuity fail safes and compression-aware prompting.
69+
70+
---
71+
72+
### u/MykoJai168
73+
Private DM – June 12, 2025
74+
(Referenced in [README.md](README.md))
75+
76+
Sparked the architectural concept behind MARM’s “Session Relay Tools” patch by proposing a layered, context-managed memory model. Offered collaboration, stress-testing interest, and early insight into multi-agent recall, which helped validate MARM’s patch direction. Credited for contributing to the prompt-layer vision and user-side continuity design.
77+
78+
---
79+
80+
## Contact Me
81+
82+
For feedback, support, or other inquiries, you can reach me here:
83+
[My Reddit Profile](https://www.reddit.com/user/Alone-Biscotti6145)
84+
[My Fiverr Profile](https://www.fiverr.com/s/YRgGkaa)
85+
86+
---
87+
88+
## Credits
89+
90+
MARM was independently built, but shaped by community input, especially feedback and shared frustrations from Reddit users exploring AI memory and context loss. Key features, including the v1.2 patch, were inspired by real user needs and suggestions. Special thanks to the Reddit prompt engineering community. Large Language Models (LLMs) were used throughout development for drafting, learning, and testing.

DESCRIPTION.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
## About the MARM Protocol
2+
3+
## Project Files
4+
5+
- [README.md](README.md) – Core introduction and quick start for using MARM.
6+
- [FAQ.md](FAQ.md) – Answers to common questions about how and why to use MARM.
7+
- [CHANGELOG.md](CHANGELOG.md) – Tracks updates, edits, and refinements to the protocol.
8+
- [CONTRIBUTING.md](CONTRIBUTING.md) – Contribution guidelines and collaborator credits.
9+
- [DESCRIPTION.md](DESCRIPTION.md) – Protocol purpose and vision overview.
10+
- [LICENSE](LICENSE) – Terms of use for this project.
11+
- [HANDBOOK.md](HANDBOOK.md) – Full guide to MARM usage, including commands, examples, and beginner to advanced tips.
12+
- [ROADMAP.md](ROADMAP.md) – Planned features, upcoming enhancements, and related protocols under development.
13+
14+
---
15+
16+
The **MARM Protocol** is the result of synthesizing insights from a wide range of discussions and feedback found across online communities, with a particular focus on Reddit threads where users shared their real-world experiences and frustrations with large language models. This community-driven approach ensures that **MARM** directly addresses the most pressing needs and challenges faced by today’s LLM users, from maintaining conversational continuity to reducing errors and hallucinations.
17+
18+
As LLMs become increasingly central to how we interact with technology, the demand for protocols that enhance reliability through structured prompting is growing rapidly. **MARM** stands out as a forward-thinking solution, designed to remain adaptable as AI platforms evolve. It enables users to structure their interaction with the AI supporting more accurate, transparent, and context-aware conversations.
19+
20+
Its ultimate goal is to make LLMs more practical and dependable for everyone.
21+
22+
---
23+
24+
## Audio Walkthrough
25+
26+
Want a guided breakdown of how MARM works and why it was built?
27+
28+
**Listen to the 5-minute AI-narrated** [Download MARM Walkthrough (MP3, 3.3 MB)](media/media_MARM_Audio_Walkthrough.mp3)
29+
This podcast-style breakdown was generated using NotebookLM, based on my original protocol documentation and design notes. The voice is AI-synthesized but the system, structure, and vision are fully mine.
30+
31+
It covers:
32+
- What MARM is
33+
- Why it exists
34+
- How it assists with managing session drift
35+
- The core logic behind the slash-command framework
36+
37+
> Designed for anyone curious about LLM session structuring, prompt architecture, or transparent protocol workflows.
38+
39+
---
40+
41+
### 📣 Looking for Collaborators
42+
43+
If you found this through Reddit or just stumbled in, I’m currently looking for:
44+
45+
- **A sharp LLM stress tester** who enjoys breaking things and spotting weak points
46+
- **Someone with social media instincts** who can help get this in front of the right audiences
47+
(no growth hacks, just signal and smart visibility)
48+
49+
If you're either of those people or know someone who is. Please feel free to open an issue, leave a comment, or DM me directly.
50+
51+
[My Reddit Profile](https://www.reddit.com/user/Alone-Biscotti6145)

FAQ.md

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
## FAQ
2+
3+
## Project Files
4+
5+
- [README.md](README.md) – Core introduction and quick start for using MARM.
6+
- [FAQ.md](FAQ.md) – Answers to common questions about how and why to use MARM.
7+
- [CHANGELOG.md](CHANGELOG.md) – Tracks updates, edits, and refinements to the protocol.
8+
- [CONTRIBUTING.md](CONTRIBUTING.md) – Contribution guidelines and collaborator credits.
9+
- [DESCRIPTION.md](DESCRIPTION.md) – Protocol purpose and vision overview.
10+
- [LICENSE](LICENSE) – Terms of use for this project.
11+
- [HANDBOOK.md](HANDBOOK.md) – Full guide to MARM usage, including commands, examples, and beginner to advanced tips.
12+
- [ROADMAP.md](ROADMAP.md) – Planned features, upcoming enhancements, and related protocols under development.
13+
14+
## FAQ
15+
16+
---
17+
18+
### 🔹 Core Concepts
19+
<details>
20+
21+
**Q: What’s new in MARM v1.2?**
22+
A: MARM v1.2 promotes session relay tools `/compile`, **reseeding**, and **structured log enforcement* as core protocol features. These tools are now standard for managing session continuity.
23+
24+
**Q: Why does MARM rely on manual steps and user-controlled commands?**
25+
A: MARM is designed for **transparency**, **control**, and **cross-platform stability**. Manual commands like `/log` and `/compile` ensure users decide **what gets remembered and when**. This avoids hidden automation, reduces drift, and makes MARM consistent even when AI memory features vary or fail.
26+
27+
**Q: Does MARM claim to fix hallucinations or eliminate memory loss?**
28+
A: No. MARM is **not a backend patch** or model-level override. It’s a **user-side protocol** built from structured prompting, manual session logging, and reseed logic. While many users report fewer hallucinations and more stable responses, MARM does **not claim to "fix" or "eliminate"** these issues only to help **mitigate** their impact through guided structure and intentional interaction.
29+
</details>
30+
31+
---
32+
33+
### 🔹 Starting & Managing Sessions
34+
<details>
35+
36+
**Q: How do I start a new session with MARM?**
37+
A: Use the `/start marm` command to activate **memory and accuracy layers** for your session. For more details, see the [Handbook.](HANDBOOK.md)
38+
39+
**Q: How do I name or rename a session?**
40+
A: Use `/log [SessionName]` (e.g., `/log SessionA`). To rename, just repeat the command with a new name.
41+
42+
**Q: What happens if I don’t name a session?**
43+
A: MARM will assign a **default session name** (e.g., “Session”) until you specify one.
44+
45+
**Q: What if I forget to log context or name a session?**
46+
A: MARM continues using the default session. You can log or rename at **any time** with `/log [SessionName]`.
47+
48+
**Q: How often or when should I log context using the `/log` command?**
49+
A: Use `/log` at the start of any **new topic, project, or session**. Log again after **major decisions**, **breakthroughs**, or pivots. For long threads, logging every few steps improves clarity and makes summaries more effective.
50+
</details>
51+
52+
---
53+
54+
### 🔹 Resuming & Reusing Sessions
55+
<details>
56+
57+
**Q: How do I resume or continue a previous session?**
58+
A: Because session memory doesn’t persist across chats, use `/compile` to summarize your logs. Then paste the **reseed block** into a new session alongside `/start marm` and `/log`.
59+
60+
**Q: What is a reseed prompt?**
61+
A: After running `/compile`, MARM generates a **paste-ready context block**. Use it to restore state in a new chat or LLM session.
62+
</details>
63+
64+
---
65+
66+
### 🔹 Commands & Functionality
67+
<details>
68+
69+
**Q: What does the `/compile` command do?**
70+
A: It creates a **one-line-per-entry digest** of your session logs. You can filter output using `--fields=Intent,Outcome`. This helps **recap session history** and supports reseeding.
71+
72+
**Q: What if I mess up a `/log` entry?**
73+
A: MARM automatically **checks formatting**. If a field is missing (like today’s date) or malformed, it will **prompt you to fix it** or auto-suggest corrections.
74+
75+
**Q: Can I see the reasoning behind a response?**
76+
A: Yes. Use `/show reasoning` to reveal the AI’s **logic chain** behind its most recent answer.
77+
</details>
78+
79+
---
80+
81+
### 🔹 Troubleshooting & Platform Support
82+
<details>
83+
84+
**Q: What should I do if the session gets too long or starts to lose context?**
85+
A: Use `/log` to checkpoint your current session, then `/compile` to create a **summary**. This keeps your place and reduces drift when continuing later.
86+
87+
**Q: Does MARM work with all AI platforms?**
88+
A: Yes. MARM is **platform-agnostic**. with core tools like `/log` and `/compile` work consistently everywhere.
89+
</details>
90+
91+
---
92+
93+
> Curious where MARM is heading?
94+
> See the [ROADMAP.md](ROADMAP.md) to view upcoming features and goals.
95+

0 commit comments

Comments
 (0)