@datafrog-io/n2n-memory 1.0.0 → 1.0.2

package/LICENSE

@@ -1,15 +1,21 @@
-ISC License
+MIT License
 
-Copyright (c) 2025, James
+Copyright (c) 2024 DataFrog IO
 
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted, provided that the above
-copyright notice and this permission notice appear in all copies.
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
-WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
-MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
-ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
-WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
-ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
-OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,60 +1,125 @@
-# N2N 记忆 (N2N Memory) MCP 服务
+# n2n-memory
+
+[English](#english) | [中文](#中文)
+
+---
+
+<a name="english"></a>
+## English
+
+A specialized MCP server designed to solve "memory pollution" during AI-assisted cross-project development. It persists AI's cognitive fragments directly within each project's own directory.
+
+### 🌟 Key Highlights
+- **Project-Level Physical Isolation**: Memory files are stored at `[Project Root]/.mcp/memory.json`.
+- **Git-Friendly**: JSON data is automatically sorted by key to generate clean and readable `git diff`.
+- **Tool Agnostic**: Uses the `.mcp` naming convention, not tied to any specific AI brand or IDE plugin.
+- **Assets for Your Code**: Memory stays with your code; team members can share AI's understanding of the architecture by simply pulling the repository.
+
+### 🚀 Quick Start
+
+#### 1. Installation & Config (IDE / Claude Desktop)
+
+The easiest way to use this is via `npx`:
+
+##### Claude Desktop
+File Path: `%APPDATA%\Claude\claude_desktop_config.json`
+
+```json
+{
+  "mcpServers": {
+    "n2n-memory": {
+      "command": "npx",
+      "args": ["-y", "@datafrog-io/n2n-memory"]
+    }
+  }
+}
+```
+
+##### Cursor / VSCode (MCP Plugin)
+Add in the MCP settings panel:
+- **Name**: `n2n-memory`
+- **Type**: `command`
+- **Command**: `npx -y @datafrog-io/n2n-memory`
+
+#### 2. Usage Guide
+
+This service is path-driven. AI assistants should pay attention to:
+
+1. **Absolute Paths**: When calling any `n2n_*` tool, the absolute path of the current project root (`projectPath`) must be provided.
+2. **Auto Storage**: Memory is automatically saved to `[ProjectPath]/.mcp/memory.json`.
+3. **Collaboration**: It is recommended to commit `.mcp/memory.json` to your Git repository to share the knowledge graph with your team.
+
+##### Available Tools:
+- `n2n_add_entities`: Create new entities.
+- `n2n_add_observations`: Append observations or facts.
+- `n2n_create_relations`: Establish connections between entities.
+- `n2n_read_graph`: Read the entire knowledge graph.
+- `n2n_search`: Search the graph via keywords (names, types, observations).
+
+---
+
+<a name="中文"></a>
+## 中文
 
 这是一个专为解决 AI 跨项目开发时“记忆污染”而设计的 MCP 服务。它将 AI 的认知碎片持久化在每个项目自己的目录下。
 
-## 核心亮点
+### 🌟 核心亮点
 - **项目级物理隔离**: 记忆文件存储在 `[项目根目录]/.mcp/memory.json`。
 - **Git 版本可控**: 自动对 JSON 数据进行字典序排序，生成清晰的 `git diff`。
 - **工具中立**: 使用 `.mcp` 命名，不绑定任何特定 AI 品牌或 IDE 插件。
-- **资产化**: 记忆随代码走，团队成员拉取仓库即可共享 AI 对架构的理解。
+- **知识资产化**: 记忆随代码走，团队成员拉取仓库即可共享 AI 对架构的理解。
 
-## 快速配置
+### 🚀 快速配置
 
-### 1. JSON 配置 (IDE / Claude Desktop)
+#### 1. JSON 配置 (IDE / Claude Desktop)
 
-根据您使用的客户端，在相应的 MCP 配置文件中添加以下内容：
+推荐使用 `npx` 模式直接运行：
 
-#### Claude Desktop
+##### Claude Desktop
 配置文件路径: `%APPDATA%\Claude\claude_desktop_config.json`
 
 ```json
 {
   "mcpServers": {
     "n2n-memory": {
-      "command": "node",
-      "args": ["D:/DevSpace/MCP_N2N_Memory/build/index.js"]
+      "command": "npx",
+      "args": ["-y", "@datafrog-io/n2n-memory"]
     }
   }
 }
 ```
 
-#### Cursor / VSCode (MCP 插件)
+##### Cursor / VSCode (MCP 插件)
 在 MCP 设置面板中添加：
 - **Name**: `n2n-memory`
 - **Type**: `command`
-- **Command**: `node D:/DevSpace/MCP_N2N_Memory/build/index.js`
+- **Command**: `npx -y @datafrog-io/n2n-memory`
 
-### 2. 使用指南 (Usage Guide)
+#### 2. 使用指南 (Usage Guide)
 
 本服务完全由路径驱动，AI 助手在调用工具时需要关注以下几点：
 
 1. **绝对路径**: 调用任何 `n2n_*` 工具时，必须传入当前项目根目录的**绝对路径**（`projectPath`）。
 2. **自动存储**: 记忆将自动保存在 `[项目路径]/.mcp/memory.json`。
-3. **协作共享**: 建议将 `.mcp/memory.json` 提交至 Git 仓库，以便团队成员共享 AI 对代码架构的理解。
+3. **协作共享**: 建议将 `.mcp/memory.json` 提交至 Git 仓库，以便团队成员共享知识图谱。
 
-#### 常用场景指令示例：
+##### 常用工具示例：
 - `n2n_add_entities`: 创建新实体。
 - `n2n_add_observations`: 追加观测事实。
 - `n2n_create_relations`: 建立实体间联系。
 - `n2n_read_graph`: 读取完整图谱。
 - `n2n_search`: 关键词搜索图谱（支持实体名、类型、观测事实）。
-- *"将这个新发现的 Bug 记录到内存中"* -> AI 将调用 `n2n_add_observations`。
 
-## 文档指引 (Docs)
+---
+
+## 📖 Related Docs | 文档指引
+
+- **[Design Solution | 设计方案](./docs/DESIGN.md)**: Why project-level isolation?
+- **[API Reference | API 参考手册](./docs/API_REFERENCE.md)**: Tool descriptions and schema.
+- **[Development | 开发指南](./docs/DEVELOPMENT.md)**: How to build, test and extend.
 
-- **[设计方案](./docs/DESIGN.md)**: 了解为什么要进行物理隔离以及核心架构设计。
-- **[API 参考手册](./docs/API_REFERENCE.md)**: 详细描述了可用的 Tool 及其参数结构。
-- **[开发与维护](./docs/DEVELOPMENT.md)**: 指导如何构建、测试和扩展本项目。
+## 📄 License | 许可证
+This project is licensed under the [MIT License](./LICENSE). | 本项目采用 [MIT 许可证](./LICENSE)。
 
-## 许可证
-本项目采用 [ISC 许可证](./LICENSE)。
+---
+**N2N Studio [@n2ns](https://github.com/n2ns)**

package/docs/API_REFERENCE.md

@@ -1,4 +1,4 @@
-# N2N Memory API 参数参考手册
+# n2n-memory API 参考手册
 
 本项目提供了一套基于项目本地路径的知识图谱管理工具。所有工具均要求传入 `projectPath` 以确保记忆的物理隔离。
 

package/docs/DESIGN.md

@@ -1,4 +1,4 @@
-# N2N Memory (N2N 记忆) 开发方案
+# n2n-memory 开发方案
 
 ## 1. 背景与目标
 解决全局 MCP Memory Server 导致的跨项目“记忆污染”与幻觉问题。通过将 AI 的认知碎片直接持久化在项目源码目录下，实现项目级的物理隔离与知识共享。

package/docs/DEVELOPMENT.md

@@ -1,4 +1,4 @@
-# 开发与维护手册
+# n2n-memory 开发指南
 
 本手册记录了 N2N Memory MCP Server 的日常开发、测试及构建流程。
 

package/package.json

@@ -1,11 +1,15 @@
 {
   "name": "@datafrog-io/n2n-memory",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "",
   "main": "build/index.js",
   "bin": {
     "n2n-memory": "build/index.js"
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/n2ns/n2n-memory.git"
+  },
   "type": "module",
   "scripts": {
     "build": "tsc",
@@ -16,7 +20,7 @@
   },
   "keywords": [],
   "author": "",
-  "license": "ISC",
+  "license": "MIT",
   "dependencies": {
     "@modelcontextprotocol/sdk": "^1.25.1",
     "fs-extra": "^11.3.3",
@@ -39,4 +43,4 @@
     "typescript": "^5.9.3",
     "typescript-eslint": "^8.50.0"
   }
-}
+}