writeragent/plugin/doc/module.yaml at master · KeithCu/writeragent · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
name: doc
title: Doc
requires: [document, config, events]

config:
  grammar_proofreader_enabled:
    type: string
    default: "off"
    widget: select
    label: Enable grammar checker (Writer)
    helper: "Off = disabled. AI (LLM) = use your configured text model/API. LanguageTool / Vale = local engines via Settings → Python venv. Harper = offline Rust binary auto-downloaded to your profile (no venv required)."
    options:
      - value: "off"
        label: "Off"
      - value: "llm"
        label: "AI (LLM)"
      - value: "languagetool"
        label: "LanguageTool (Local)"
      - value: "vale"
        label: "Vale (Local Style) (WIP)"
      - value: "harper"
        label: "Harper"
    inline: true
    label_x: 8
    label_width: 100
    x: 110
    width: 100


  grammar_proofreader_model:
    type: string
    default: ""
    widget: text
    label: Model (optional)
    helper: "Leave empty to use the same text model as chat."
    label_x: 220
    label_width: 95
    x: 318
    width: 106

  grammar_proofreader_pause_during_agent:
    type: boolean
    default: false
    widget: checkbox
    label: Pause grammar while chat/agent runs
    helper: "When on, AI grammar skips background requests while sidebar chat or agent runs, to avoid concurrent API calls."


  grammar_proofreader_batch_sentences:
    type: int
    default: 1
    min: 1
    max: 8
    widget: number
    label: Batch sentences
    helper: "Number of sentences to send per LLM request (1-8). 1 (default) is most reliable; higher values are faster and cheaper but may hit token limits or cause model errors."
    inline: true
    x: 110
    width: 100

  grammar_proofreader_max_in_flight:
    type: int
    default: 1
    min: 1
    max: 8
    widget: number
    label: Concurrent requests
    helper: "Max simultaneous background grammar API calls (1-8). 1 matches prior behavior. Raise for OpenRouter or other providers that allow parallel requests; use with care alongside sidebar chat."
    label_x: 220
    label_width: 100
    x: 322
    width: 100

  grammar_proofreader_detect_language:
    type: string
    default: "off"
    widget: select
    label: Sentence language detection
    helper: "Verify each complete sentence's language against the document locale. AI uses your grammar/chat API; Local uses langdetect in your Python venv (Settings → Python; no API call). Mismatches update CharLocale and re-check grammar."
    options:
      - value: "off"
        label: "Off"
      - value: "llm"
        label: "AI (LLM)"
      - value: "langdetect"
        label: "Local (langdetect)"

  chat_enter_key_sends_message:
    type: boolean
    default: true
    widget: checkbox
    label: Enter key sends sidebar chat message
    helper: "When on, Enter in the sidebar query runs the same action as Send; Shift+Enter inserts a newline. When off, Enter inserts a newline."

  agent_edit_review_mode:
    type: string
    default: "off"
    widget: select
    label: Agent edit review
    helper: "Off = direct edits. Record = tracked changes you accept/reject yourself. Wait = apply_document_content blocks (on chat/MCP worker thread) until you review."
    options:
      - value: "off"
        label: "Off"
      - value: "record"
        label: "Record (track changes)"
      - value: "wait"
        label: "Wait for review"

  edit_review_timeout:
    type: int
    default: 900
    min: 0
    widget: number
    internal: true
    label: Edit review max wait (seconds)
    helper: "Only used when mode is Wait. Max time apply_document_content blocks before returning with pending changes."