mirror of
https://github.com/agentscope-ai/ReMe.git
synced 2026-09-30 01:52:29 +00:00
83bfddb4a4
* refactor(config): streamline job descriptions and parameter docs - Simplify descriptions for search, traverse, list, read, stat, frontmatter:read, write, edit, append, frontmatter:update, frontmatter:delete, move, delete, upload, upload_resource, and download jobs - Shorten parameter descriptions to be more concise - Maintain essential information while reducing verbosity refactor(steps): rename daily steps and consolidate functionality - Rename daily_resolve_step to daily_read_step - Rename daily_create_step to daily_write_step - Update __init__.py imports to reflect new step names - Consolidate daily operations documentation refactor(daily): extract helper functions and improve structure - Rename _day_index.py to _daily_io.py - Extract validate_slug function for Windows-safe filename validation - Move scan_notes function to public interface - Add comprehensive docstrings explaining slug validation and day-index rebuild concerns feat(daily): decouple list operation from index refresh - Remove automatic day index refresh from daily_list_step - Change daily_list_step to pure read operation with no side effects - Sort notes by slug for stable output - Update documentation to clarify read/write separation refactor(daily): remove deprecated create step - Remove unused daily/create.py module - Simplify daily operations to focus on CRUD patterns * refactor(daily): replace module imports with explicit step class imports
570 lines
15 KiB
YAML
570 lines
15 KiB
YAML
service:
|
|
backend: http
|
|
# backend: mcp
|
|
|
|
# Default dev config points vault_dir at ./.reme so `python -m reme4 start`
|
|
# can be run from the repo root and exercise the full atomic-tool surface
|
|
# against the seeded test data. Override the `vault_dir=` CLI arg.
|
|
vault_dir: .reme
|
|
daily_dir: daily
|
|
digest_dir: digest
|
|
resource_dir: resource
|
|
|
|
jobs:
|
|
# ════════════════════════════════════════════════════════════════════
|
|
# UTILITY — service introspection
|
|
# ════════════════════════════════════════════════════════════════════
|
|
- backend: base
|
|
name: version
|
|
description: "return reme4 package version"
|
|
parameters:
|
|
type: object
|
|
properties: {}
|
|
steps:
|
|
- backend: version_step
|
|
|
|
- backend: base
|
|
name: health_check
|
|
description: "return a concise health-check snapshot of reme4 components"
|
|
parameters:
|
|
type: object
|
|
properties: {}
|
|
steps:
|
|
- backend: health_check_step
|
|
|
|
- backend: base
|
|
name: help
|
|
description: "list all registered jobs with their metadata"
|
|
parameters:
|
|
type: object
|
|
properties: {}
|
|
steps:
|
|
- backend: help_step
|
|
|
|
- backend: base
|
|
name: reindex
|
|
description: "wipe the file store and rebuild it from the watcher's tracked files"
|
|
parameters:
|
|
type: object
|
|
properties: {}
|
|
steps:
|
|
- backend: reindex_step
|
|
|
|
- backend: base
|
|
name: index_changes
|
|
description: "apply a batch of file changes (added/modified/deleted) into file_store"
|
|
parameters:
|
|
type: object
|
|
properties:
|
|
changes:
|
|
type: array
|
|
description: "list of change items"
|
|
items:
|
|
type: object
|
|
properties:
|
|
change:
|
|
type: string
|
|
enum: [added, modified, deleted]
|
|
description: "type of file change"
|
|
path:
|
|
type: string
|
|
description: "absolute file path"
|
|
required:
|
|
- change
|
|
- path
|
|
required:
|
|
- changes
|
|
steps:
|
|
- backend: index_changes_step
|
|
|
|
# ════════════════════════════════════════════════════════════════════
|
|
# ATOMIC TOOLS — same surface plugins/reme-{service,expert} expose
|
|
# ════════════════════════════════════════════════════════════════════
|
|
|
|
# ── Retrieve ───────────────────────────────────────────────────────
|
|
- backend: base
|
|
name: search
|
|
description: "Hybrid vault search (vector + BM25, RRF-fused)."
|
|
parameters:
|
|
type: object
|
|
properties:
|
|
query:
|
|
type: string
|
|
description: "search query"
|
|
limit:
|
|
type: integer
|
|
description: "max results"
|
|
default: 5
|
|
min_score:
|
|
type: number
|
|
description: "min fused score"
|
|
default: 0.0
|
|
required:
|
|
- query
|
|
steps:
|
|
- backend: search_step
|
|
vector_weight: 0.7
|
|
candidate_multiplier: 3.0
|
|
expand_links: true
|
|
max_links_per_direction: 10
|
|
|
|
- backend: base
|
|
name: traverse
|
|
description: "Walk the wikilink graph from a seed path."
|
|
parameters:
|
|
type: object
|
|
properties:
|
|
path:
|
|
type: string
|
|
description: "seed path (vault-relative)"
|
|
depth:
|
|
type: integer
|
|
description: "hop limit"
|
|
default: 1
|
|
direction:
|
|
type: string
|
|
description: "forward / backward / both"
|
|
default: both
|
|
required:
|
|
- path
|
|
steps:
|
|
- backend: traverse_step
|
|
|
|
# ── Read Operations ───────────────────────────────────────────────────────────
|
|
- backend: base
|
|
name: list
|
|
description: "List files under a vault path."
|
|
parameters:
|
|
type: object
|
|
properties:
|
|
path:
|
|
type: string
|
|
description: "vault-relative dir; empty = root"
|
|
default: ""
|
|
recursive:
|
|
type: boolean
|
|
description: "recurse"
|
|
default: false
|
|
limit:
|
|
type: integer
|
|
description: "max results"
|
|
default: 100
|
|
steps:
|
|
- backend: list_step
|
|
|
|
- backend: base
|
|
name: read
|
|
description: "Read a markdown file under the vault."
|
|
parameters:
|
|
type: object
|
|
properties:
|
|
path:
|
|
type: string
|
|
description: "vault-relative path; markdown only"
|
|
start_line:
|
|
type: integer
|
|
description: "first line (1-based, inclusive)"
|
|
end_line:
|
|
type: integer
|
|
description: "last line (1-based, inclusive)"
|
|
required:
|
|
- path
|
|
steps:
|
|
- backend: read_step
|
|
|
|
- backend: base
|
|
name: stat
|
|
description: "Stat a vault file (size, mtime, exists, is_dir, is_file)."
|
|
parameters:
|
|
type: object
|
|
properties:
|
|
path:
|
|
type: string
|
|
description: "vault-relative path"
|
|
required:
|
|
- path
|
|
steps:
|
|
- backend: stat_step
|
|
|
|
- backend: base
|
|
name: frontmatter:read
|
|
description: "Read a file's YAML frontmatter as a dict."
|
|
parameters:
|
|
type: object
|
|
properties:
|
|
path:
|
|
type: string
|
|
description: "vault-relative path"
|
|
required:
|
|
- path
|
|
steps:
|
|
- backend: frontmatter:read_step
|
|
|
|
# ── Write Operations──────────────────────────────────────────────────────────
|
|
- backend: base
|
|
name: write
|
|
description: "Write a markdown file (create or overwrite) with name/description frontmatter."
|
|
parameters:
|
|
type: object
|
|
properties:
|
|
path:
|
|
type: string
|
|
description: "vault-relative path; markdown only"
|
|
name:
|
|
type: string
|
|
description: "frontmatter name"
|
|
description:
|
|
type: string
|
|
description: "frontmatter description"
|
|
content:
|
|
type: string
|
|
description: "body"
|
|
required:
|
|
- path
|
|
- name
|
|
- description
|
|
- content
|
|
steps:
|
|
- backend: write_step
|
|
|
|
- backend: base
|
|
name: edit
|
|
description: "Find-and-replace in a markdown file (all occurrences)."
|
|
parameters:
|
|
type: object
|
|
properties:
|
|
path:
|
|
type: string
|
|
description: "vault-relative path"
|
|
old:
|
|
type: string
|
|
description: "text to find"
|
|
new:
|
|
type: string
|
|
description: "replacement"
|
|
default: ""
|
|
required:
|
|
- path
|
|
- old
|
|
- new
|
|
steps:
|
|
- backend: edit_step
|
|
|
|
- backend: base
|
|
name: append
|
|
description: "Append content to a markdown file."
|
|
parameters:
|
|
type: object
|
|
properties:
|
|
path:
|
|
type: string
|
|
description: "vault-relative path"
|
|
content:
|
|
type: string
|
|
description: "content to append"
|
|
required:
|
|
- path
|
|
- content
|
|
steps:
|
|
- backend: append_step
|
|
|
|
- backend: base
|
|
name: frontmatter:update
|
|
description: "Merge keys into a file's YAML frontmatter."
|
|
parameters:
|
|
type: object
|
|
properties:
|
|
path:
|
|
type: string
|
|
description: "vault-relative path"
|
|
metadata:
|
|
type: object
|
|
description: "keys to merge"
|
|
additionalProperties: true
|
|
required:
|
|
- path
|
|
- metadata
|
|
steps:
|
|
- backend: frontmatter_update_step
|
|
|
|
- backend: base
|
|
name: frontmatter:delete
|
|
description: "Drop keys from a file's YAML frontmatter."
|
|
parameters:
|
|
type: object
|
|
properties:
|
|
path:
|
|
type: string
|
|
description: "vault-relative path"
|
|
keys:
|
|
type: array
|
|
description: "keys to remove"
|
|
items:
|
|
type: string
|
|
required:
|
|
- path
|
|
- keys
|
|
steps:
|
|
- backend: frontmatter_delete_step
|
|
|
|
# ── File Operations (relocate / cross-realm) ──────────────────────────────
|
|
- backend: base
|
|
name: move
|
|
description: "Move / rename a vault file; rewrites inbound wikilinks by default."
|
|
parameters:
|
|
type: object
|
|
properties:
|
|
src_path:
|
|
type: string
|
|
description: "vault-relative source"
|
|
dst_path:
|
|
type: string
|
|
description: "vault-relative destination"
|
|
overwrite:
|
|
type: boolean
|
|
description: "overwrite if dst exists"
|
|
default: false
|
|
retarget:
|
|
type: boolean
|
|
description: "rewrite [[src]] → [[dst]] across the vault"
|
|
default: true
|
|
required:
|
|
- src_path
|
|
- dst_path
|
|
steps:
|
|
- backend: move_step
|
|
|
|
- backend: base
|
|
name: delete
|
|
description: "Delete a vault file or folder; returns surviving inbound wikilinks."
|
|
parameters:
|
|
type: object
|
|
properties:
|
|
path:
|
|
type: string
|
|
description: "vault-relative path"
|
|
required:
|
|
- path
|
|
steps:
|
|
- backend: delete_step
|
|
|
|
- backend: base
|
|
name: upload
|
|
description: "Copy a host file into the vault at an explicit destination."
|
|
parameters:
|
|
type: object
|
|
properties:
|
|
src_path:
|
|
type: string
|
|
description: "host absolute path"
|
|
dst_path:
|
|
type: string
|
|
description: "vault-relative destination"
|
|
overwrite:
|
|
type: boolean
|
|
description: "overwrite if dst exists"
|
|
default: false
|
|
required:
|
|
- src_path
|
|
- dst_path
|
|
steps:
|
|
- backend: upload_step
|
|
|
|
- backend: base
|
|
name: upload_resource
|
|
description: "Ingest an external-channel asset into resource/<today>/ with provenance."
|
|
parameters:
|
|
type: object
|
|
properties:
|
|
path:
|
|
type: string
|
|
description: "host source path"
|
|
channel:
|
|
type: string
|
|
description: "channel id (wechat / email / browser / api / ...)"
|
|
description:
|
|
type: string
|
|
description: "what the asset is and how to interpret it"
|
|
metadata:
|
|
type: object
|
|
description: "extra provenance keys (e.g. source)"
|
|
default: {}
|
|
required:
|
|
- path
|
|
- channel
|
|
- description
|
|
steps:
|
|
- backend: upload_resource_step
|
|
|
|
- backend: base
|
|
name: download
|
|
description: "Copy a vault file out to the host filesystem."
|
|
parameters:
|
|
type: object
|
|
properties:
|
|
src_path:
|
|
type: string
|
|
description: "vault-relative source"
|
|
dst_path:
|
|
type: string
|
|
description: "host absolute dest; empty = temp file"
|
|
default: ""
|
|
overwrite:
|
|
type: boolean
|
|
description: "overwrite if dst exists"
|
|
default: false
|
|
required:
|
|
- src_path
|
|
steps:
|
|
- backend: download_step
|
|
|
|
# ── Daily Operations (note CRUD + day-index rollup) ───────────────────
|
|
- backend: base
|
|
name: daily:read
|
|
description: "Read daily/<date>/<slug>.md (body + frontmatter)."
|
|
parameters:
|
|
type: object
|
|
properties:
|
|
slug:
|
|
type: string
|
|
description: "note slug"
|
|
date:
|
|
type: string
|
|
description: "ISO date; empty = today"
|
|
default: ""
|
|
required:
|
|
- slug
|
|
steps:
|
|
- backend: daily_read_step
|
|
|
|
- backend: base
|
|
name: daily:write
|
|
description: "Write daily/<date>/<slug>.md (body + frontmatter); refreshes the day index."
|
|
parameters:
|
|
type: object
|
|
properties:
|
|
slug:
|
|
type: string
|
|
description: "note slug"
|
|
body:
|
|
type: string
|
|
description: "note body"
|
|
default: ""
|
|
frontmatter:
|
|
type: object
|
|
description: "frontmatter dict; defaults to {name: <slug>}"
|
|
default: {}
|
|
date:
|
|
type: string
|
|
description: "ISO date; empty = today"
|
|
default: ""
|
|
overwrite:
|
|
type: boolean
|
|
description: "false = skip if exists; true = replace"
|
|
default: false
|
|
refresh_index:
|
|
type: boolean
|
|
description: "refresh daily/<date>.md after write"
|
|
default: true
|
|
required:
|
|
- slug
|
|
steps:
|
|
- backend: daily_write_step
|
|
|
|
- backend: base
|
|
name: daily:list
|
|
description: "List notes under a single day."
|
|
parameters:
|
|
type: object
|
|
properties:
|
|
date:
|
|
type: string
|
|
description: "ISO date; empty = today"
|
|
default: ""
|
|
steps:
|
|
- backend: daily_list_step
|
|
|
|
- backend: base
|
|
name: daily:reindex
|
|
description: "Rebuild the day-index page daily/<date>.md."
|
|
parameters:
|
|
type: object
|
|
properties:
|
|
date:
|
|
type: string
|
|
description: "ISO date; empty = today"
|
|
default: ""
|
|
steps:
|
|
- backend: daily_reindex_step
|
|
|
|
- backend: background
|
|
name: watch_file
|
|
watch_paths:
|
|
- MEMORY.md
|
|
- memory
|
|
suffix_filters:
|
|
- md
|
|
steps:
|
|
- backend: update_store_step
|
|
- backend: watch_changes_step
|
|
|
|
components:
|
|
tokenizer:
|
|
default:
|
|
backend: regex
|
|
|
|
embedding_model:
|
|
default:
|
|
backend: ${EMBEDDING_BACKEND:-openai}
|
|
api_key: ${EMBEDDING_API_KEY:-}
|
|
base_url: ${EMBEDDING_BASE_URL:-https://api.openai.com/v1}
|
|
model_name: ${EMBEDDING_MODEL_NAME:-text-embedding-v4}
|
|
dimensions: 1024
|
|
|
|
file_graph:
|
|
default:
|
|
backend: local
|
|
|
|
file_parser:
|
|
linked:
|
|
backend: linked
|
|
supported_extensions:
|
|
- md
|
|
chunked:
|
|
backend: chunked
|
|
supported_extensions:
|
|
- txt
|
|
- html
|
|
- json
|
|
- yaml
|
|
- py
|
|
default:
|
|
backend: default
|
|
|
|
keyword_index:
|
|
default:
|
|
backend: bm25
|
|
tokenizer: default
|
|
|
|
file_store:
|
|
default:
|
|
backend: local
|
|
store_name: local
|
|
embedding_model: default
|
|
keyword_index: default
|
|
file_graph: default
|
|
|
|
# as_llm / formatter aren't required for atomic primitives; configure
|
|
# only if you'll invoke digester/synchronizer or other LLM-driven
|
|
# paths from the dev server.
|
|
# as_llm:
|
|
# default:
|
|
# backend: ${LLM_BACKEND:-openai}
|
|
# api_key: ${LLM_API_KEY:-}
|
|
# model_name: ${LLM_MODEL_NAME:-gpt-4o-mini}
|
|
# client_kwargs:
|
|
# base_url: ${LLM_BASE_URL:-https://api.openai.com/v1}
|
|
#
|
|
# as_llm_formatter:
|
|
# default:
|
|
# backend: ${LLM_BACKEND:-openai}
|