mn-docs-mcp 0.6.0 → 0.6.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -98,7 +98,6 @@ async function ensureReady() {
98
98
 
99
99
  function renderJsonPayload(payload) {
100
100
  return {
101
- structuredContent: payload,
102
101
  content: [
103
102
  {
104
103
  type: 'text',
package/mcp/server.mjs CHANGED
@@ -101,7 +101,6 @@ async function ensureReady() {
101
101
 
102
102
  function renderJsonPayload(payload) {
103
103
  return {
104
- structuredContent: payload,
105
104
  content: [
106
105
  {
107
106
  type: 'text',
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "mn-docs-mcp",
3
3
  "type": "module",
4
- "version": "0.6.0",
4
+ "version": "0.6.2",
5
5
  "repository": {
6
6
  "type": "git",
7
7
  "url": "https://github.com/Temsys-Shen/marginnote-addon-docs.git"
@@ -3,7 +3,7 @@ title: NSError
3
3
  description: 错误对象,包含 domain/code/userInfo 与本地化描述信息。
4
4
  ---
5
5
 
6
- `NSError` 用于表示错误信息。网络请求(如 `NSURLConnection`)或文件 API 可能通过 `NSError **` 返回错误对象(JS 侧通常作为回调参数或返回值的一部分出现)。
6
+ `NSError` 用于表示错误信息。网络请求(如 `NSURLConnection`)或文件API可能通过`NSError **`返回错误对象,JS侧通常作为回调参数或返回值的一部分出现。
7
7
 
8
8
  ## 类成员 (Class members)
9
9
 
@@ -139,7 +139,7 @@ getObjectValueForStringRangeError(obj: any, string: string, rangep: any, error:
139
139
 
140
140
  ### 进阶
141
141
 
142
- 本类型还导出了大量与舍入、科学计数、货币、百分比、解析容错、符号显示相关的 getter/setter(例如 roundingModecurrencyCodepercentSymbollenientusesSignificantDigits 等)。可通过站内搜索成员名定位。
142
+ 本类型还导出了大量与舍入、科学计数、货币、百分比、解析容错、符号显示相关的可读写成员,例如`roundingMode`、`currencyCode`、`percentSymbol`、`lenient`、`usesSignificantDigits`等。可通过站内搜索成员名定位。
143
143
 
144
144
  ## 相关
145
145
 
@@ -3,7 +3,7 @@ title: NSProxy
3
3
  description: 代理基类(消息转发基础设施)。
4
4
  ---
5
5
 
6
- `NSProxy` 是 Objective‑C 世界里的代理基类。在插件环境中,你一般不会直接创建它,但可能会在调试/反射/桥接场景里遇到它的基础方法。
6
+ `NSProxy`是系统代理基类,提供消息转发相关能力。在插件环境中,你一般不会直接创建它,但可能会在调试/反射/桥接场景里遇到它的基础方法。
7
7
 
8
8
  ## 类成员 (Class members)
9
9
 
@@ -3,7 +3,7 @@ title: NSTimer
3
3
  description: 定时器,延迟执行或周期执行回调。
4
4
  ---
5
5
 
6
- 用于延迟执行或重复执行一段代码。JS 侧通过 `scheduledTimerWithTimeInterval(ti, repeats, block)` 创建,block 接收 timer 参数。
6
+ 用于延迟执行或重复执行一段代码。JS侧通过`scheduledTimerWithTimeInterval(ti, repeats, block)`创建,block接收timer参数。
7
7
 
8
8
  ## 类成员 (Class members)
9
9
 
@@ -25,7 +25,7 @@ static sharedInstance(): Application
25
25
 
26
26
  | 属性 | 类型 | 说明 |
27
27
  | :--- | :--- | :--- |
28
- | `focusWindow` | `UIWindow` | 当前活动窗口(文档中有时写作 `window`,getter 为 window)。 |
28
+ | `focusWindow` | `UIWindow` | 当前活动窗口,文档中有时写作`window`。 |
29
29
  | `currentTheme` | `string` | 当前主题,包括 `Default` / `Sepia`/ `Gray` / `Dark` / `Green`。 |
30
30
  | `dbPath` | `string` | 主数据库文件路径。 |
31
31
  | `documentPath` | `string` | 文稿目录路径。 |
@@ -62,7 +62,7 @@ log(format: string, ...args: any[]): void
62
62
 
63
63
  | Name | Type | Description |
64
64
  | :---------- | :--------- | :------------------------------------------------------ |
65
- | `format` | `string` | 格式化字符串,支持 `%@`、`%d` 等 Objective-C 格式。 |
65
+ | `format` | `string` | 格式化字符串,支持`%@`、`%d`等占位符。 |
66
66
  | `...args` | `any[]` | 对应格式化字符串的参数。 |
67
67
 
68
68
  ### `require`
@@ -43,16 +43,16 @@ var notebook = db.getNotebookById("NOTEBOOK_ID");
43
43
  var doc = db.getDocumentById("DOC_MD5");
44
44
 
45
45
  if (notebook && doc) {
46
- var topicid = notebook.topicId || notebook.topicid; // 兼容不同 getter 命名
46
+ var topicId = notebook.topicId;
47
47
  UndoManager.sharedInstance().undoGrouping(
48
48
  "创建笔记",
49
- topicid,
49
+ topicId,
50
50
  function () {
51
51
  var note = Note.createWithTitleNotebookDocument("新笔记", notebook, doc);
52
52
  // note 为 MbBookNote
53
53
  }
54
54
  );
55
- Application.sharedInstance().refreshAfterDBChanged(topicid);
55
+ Application.sharedInstance().refreshAfterDBChanged(topicId);
56
56
  }
57
57
  ```
58
58
 
@@ -75,7 +75,7 @@ MarginNote插件运行在JavaScriptCore中,而不是浏览器环境。这意
75
75
 
76
76
  ## 环境差异与建议
77
77
 
78
- - 插件环境没有原生fetch。需要网络请求时,请使用已导出的Objective‑C网络类。
78
+ - 插件环境没有原生fetch。需要网络请求时,请使用文档提供的网络请求API。
79
79
  - 插件环境没有setTimeout/setInterval。建议使用NSTimer完成延时与轮询。
80
80
 
81
81
  ## 相关
@@ -11,12 +11,12 @@ description: 单个文档的控制器,提供当前文档与选区。
11
11
 
12
12
  | 属性 | 类型 | 说明 |
13
13
  |------|------|------|
14
- | `document` | `MbBook` \| undefined | 当前文档对象(getter 为 currBook)。 |
15
- | `docMd5` | `string` | 当前文档 MD5(getter 为 currentBookMd5)。 |
16
- | `notebookId` | `string` | 当前笔记本 ID(getter 为 currTopicId)。 |
14
+ | `document` | `MbBook` \| undefined | 当前文档对象。 |
15
+ | `docMd5` | `string` | 当前文档MD5 |
16
+ | `notebookId` | `string` | 当前笔记本ID |
17
17
  | `focusNote` | `MbBookNote` \| undefined | 当前焦点笔记。 |
18
18
  | `visibleFocusNote` | `MbBookNote` \| undefined | 当前可见的焦点笔记。 |
19
- | `lastFocusNote` | `MbBookNote` \| undefined | 上一次的焦点笔记(getter 为 lastFocusNote)。 |
19
+ | `lastFocusNote` | `MbBookNote` \| undefined | 上一次的焦点笔记。 |
20
20
  | `selectionText` | `string` \| undefined | 用户在 PDF 中当前选中的文本。 |
21
21
  | `currPageNo` | `number` | 当前页码(运行时定义,通常从 1 开始)。 |
22
22
  | `currPageIndex` | `number` | 当前页索引(运行时定义,通常从 0 开始)。 |
@@ -35,12 +35,12 @@ description: 笔记核心对象,代表脑图中的一条笔记及其摘录、
35
35
  | `groupNoteId` | `string` | 分组笔记 ID。 |
36
36
  | `comments` | `NSArray` | 评论数组,元素为 [NoteComment](/reference/marginnote/note-comment/) 结构。 |
37
37
  | `parentNote` | `MbBookNote` \| undefined | 父笔记。 |
38
- | `childMindMap` | `MbBookNote` \| undefined | 子脑图(getter 为 parentDraft)。 |
38
+ | `childMindMap` | `MbBookNote` \| undefined | 子脑图。 |
39
39
  | `linkedNotes` | `NSArray` | 链接的笔记。 |
40
40
  | `childNotes` | `NSArray` | 子笔记数组。 |
41
41
  | `summaryLinks` | `NSArray` | 摘要链接。 |
42
42
  | `zLevel` / `hidden` / `toc` / `annotation` / `textFirst` / `groupMode` / `flashcard` / `flagged` | `NSNumber` | 各类标志。 |
43
- | `summary` | `boolean` | 是否有摘要链接(getter hasSummaryLinks)。 |
43
+ | `summary` | `boolean` | 是否有摘要链接。 |
44
44
  | `textHighlight` / `options` | `NSDictionary` | 文本高亮与选项。 |
45
45
 
46
46
  ### 实例方法
@@ -162,7 +162,7 @@ allNoteText(): string
162
162
 
163
163
  ### `createWithTitleNotebookDocument`
164
164
 
165
- 创建新笔记(类方法)。在 JS 侧通常通过全局注入的 `Note` 对象调用同名方法。
165
+ 创建新笔记类方法。在JS侧通常通过全局注入的`Note`对象调用同名方法。
166
166
 
167
167
  ```javascript
168
168
  static createWithTitleNotebookDocument(title: string, notebook: MbTopic, document: MbBook): MbBookNote
@@ -11,11 +11,11 @@ description: 文档对象,代表一个 PDF/EPUB 文档。
11
11
 
12
12
  | 属性 | 类型 | 说明 |
13
13
  |------|------|------|
14
- | `docMd5` | `string` | 文档唯一 MD5(getter 为 md5real)。 |
15
- | `docTitle` | `string` | 文档标题(getter 为 bookTitle)。 |
14
+ | `docMd5` | `string` | 文档唯一MD5 |
15
+ | `docTitle` | `string` | 文档标题。 |
16
16
  | `pathFile` | `string` | 文档在 MarginNote 存储中的相对路径。 |
17
17
  | `fullPathFileName` | `string` | 文档的完整路径(若环境可用)。 |
18
- | `currentTopicId` | `string` | 当前所属笔记本 ID(getter 为 currenttopicid)。 |
18
+ | `currentTopicId` | `string` | 当前所属笔记本ID |
19
19
  | `lastVisit` | `NSDate` | 最后访问时间。 |
20
20
  | `pageCount` | `number` | 总页数。 |
21
21
 
@@ -12,16 +12,16 @@ description: 笔记本(主题)对象,包含根笔记列表与关联文档
12
12
  | 属性 | 类型 | R/W | 说明 |
13
13
  |------|------|-----|------|
14
14
  | `topicId` | `string` | R | 笔记本唯一 ID。 |
15
- | `title` | `string` | R/W | 笔记本标题(setter 为 setTopicTitle)。 |
15
+ | `title` | `string` | R/W | 笔记本标题。 |
16
16
  | `lastVisit` | `NSDate` | R | 最后访问时间。 |
17
- | `mainDocMd5` | `string` | R | 主文档 MD5(getter 为 localbookmd5)。 |
17
+ | `mainDocMd5` | `string` | R | 主文档MD5 |
18
18
  | `historyDate` | `NSDate` | R | 历史日期。 |
19
19
  | `syncMode` | `NSNumber` | R | 同步模式。 |
20
- | `categoryList` | `string` | R | 分类列表(getter 为 taglist)。 |
20
+ | `categoryList` | `string` | R | 分类列表。 |
21
21
  | `hashtags` | `string` | R | 标签。 |
22
- | `docList` | `string` | R | 文档列表(getter 为 booklist)。 |
22
+ | `docList` | `string` | R | 文档列表。 |
23
23
  | `options` | `NSDictionary` | R | 选项。 |
24
- | `documents` | `NSArray` | R | 关联文档数组(getter 为 books)。 |
24
+ | `documents` | `NSArray` | R | 关联文档数组。 |
25
25
  | `notes` | `NSArray` | R | 笔记本中所有**根节点**笔记。 |
26
26
  | `hideLinksInMindMapNode` | `boolean` | R/W | 是否在脑图节点中隐藏链接。 |
27
27
  | `flags` | `NSNumber` | R | 标志位。 |
@@ -12,8 +12,8 @@ description: 脑图中的单个节点,关联一条 MbBookNote 与父子节点
12
12
  | 属性 | 类型 | 说明 |
13
13
  |------|------|------|
14
14
  | `note` | `MbBookNote` | 该节点关联的笔记对象。 |
15
- | `parentNode` | `MindMapNode` \| undefined | 父节点(getter 为 parentNote,类型为 MindMapNote)。 |
16
- | `childNodes` | `NSArray` | 子节点数组(getter 为 childNotes)。 |
15
+ | `parentNode` | `MindMapNode` \| undefined | 父节点。 |
16
+ | `childNodes` | `NSArray` | 子节点数组。 |
17
17
  | `summaryLinks` | `NSArray` | 摘要链接。 |
18
18
  | `frame` | `CGRect` | 节点在脑图视图中的位置与大小。 |
19
19
 
@@ -11,9 +11,9 @@ description: 脑图与大纲的控制器,提供当前笔记本与焦点笔记
11
11
 
12
12
  | 属性 | 类型 | 说明 |
13
13
  | :--- | :--- | :--- |
14
- | `mindmapView` | `MindMapView` | 脑图视图(getter 为 noteMindMap)。 |
14
+ | `mindmapView` | `MindMapView` | 脑图视图。 |
15
15
  | `outlineView` | `OutlineView` | 大纲视图。 |
16
- | `notebookId` | `string` | 当前笔记本 ID(getter 为 currTopic)。 |
16
+ | `notebookId` | `string` | 当前笔记本ID |
17
17
  | `focusNote` | `MbBookNote` \| undefined | 当前在脑图中聚焦的笔记。 |
18
18
  | `visibleFocusNote` | `MbBookNote` \| undefined | 当前可见的焦点笔记。 |
19
19
  | `view` | `UIView` | 控制器视图(继承自 UIViewController)。 |
@@ -11,8 +11,8 @@ description: 文档阅读区域控制器,管理当前显示的文档控制器
11
11
 
12
12
  | 属性 | 类型 | 说明 |
13
13
  |------|------|------|
14
- | `currentDocumentController` | `DocumentController` | 当前正在显示的文档控制器(getter 为 fBookViewController)。 |
15
- | `documentControllers` | `NSMutableArray` | 所有文档控制器(getter 为 bookViewControllers)。 |
14
+ | `currentDocumentController` | `DocumentController` | 当前正在显示的文档控制器。 |
15
+ | `documentControllers` | `NSMutableArray` | 所有文档控制器。 |
16
16
 
17
17
  说明:该对象具备 `UIViewController` 的基础能力(例如 `view`),并额外提供“当前文档控制器/全部文档控制器”等阅读区状态。
18
18
 
@@ -12,13 +12,13 @@ description: 学习场景主视图控制器,访问脑图与文档的入口。
12
12
  | 属性 | 类型 | 说明 |
13
13
  | :--- | :--- | :--- |
14
14
  | `view` | `UIView` | 控制器主视图,可在此添加插件 UI。 |
15
- | `notebookController` | `NotebookController` | 脑图/大纲控制器(getter 为 `fSearchViewController`,JS 侧为 notebookController)。 |
16
- | `readerController` | `ReaderController` | 文档阅读区域控制器(getter 为 `detailController`)。 |
15
+ | `notebookController` | `NotebookController` | 脑图/大纲控制器。 |
16
+ | `readerController` | `ReaderController` | 文档阅读区域控制器。 |
17
17
  | `studyMode` | `number` | 当前学习模式:0/1 文档模式,2 学习模式,3 复习模式。 |
18
18
  | `narrowMode` | `boolean` | 是否窄屏模式(窄屏下书本分屏模式 1 不可用)。 |
19
- | `docMapSplitMode` | `number` | 书本/脑图分屏模式:0 全脑图,1 半脑图半文档,2 全文档(getter/setter 为 bookSplitMode)。 |
19
+ | `docMapSplitMode` | `number` | 书本/脑图分屏模式:0 全脑图,1 半脑图半文档,2 全文档。 |
20
20
  | `rightMapMode` | `boolean` | 脑图是否在右侧。 |
21
- | `extensionPanelController` | `UIViewController` | 扩展面板控制器(getter 为 extensionController)。 |
21
+ | `extensionPanelController` | `UIViewController` | 扩展面板控制器。 |
22
22
 
23
23
  ### 方法
24
24
 
@@ -14,7 +14,7 @@ UIWebView 用于在插件中嵌入网页或本地 HTML 页面,继承自 [UIVie
14
14
  | `delegate` | `id` | 实现 UIWebViewDelegate 的对象,通常为承载 WebView 的 ViewController(self)。 |
15
15
  | `scrollView` | `UIScrollView` | 只读,内嵌滚动视图。 |
16
16
  | `request` | `NSURLRequest` | 只读,当前请求。 |
17
- | `loading` | `boolean` | 只读,是否正在加载(getter 为 isLoading)。 |
17
+ | `loading` | `boolean` | 只读,是否正在加载。 |
18
18
  | `canGoBack` | `boolean` | 只读,是否可后退。 |
19
19
  | `canGoForward` | `boolean` | 只读,是否可前进。 |
20
20
  | `scalesPageToFit` | `boolean` | 是否按比例缩放以适应视图。 |
@@ -52,7 +52,7 @@ loadHTMLStringBaseURL(string: string, baseURL: NSURL | null): void
52
52
  | `string` | `string` | HTML 内容字符串。 |
53
53
  | `baseURL` | `NSURL \| null` | 基础 URL(用于解析相对路径)。 |
54
54
 
55
- **Note:** 该方法对应 Objective‑C 的 `loadHTMLString:baseURL:`,JS 侧为参数标签拼接后的方法名。
55
+ **说明:** 该方法名由参数标签拼接得到。
56
56
 
57
57
  ### `loadDataMIMETypeTextEncodingNameBaseURL`
58
58