OpenParable
Skip to content
← Back to skills

Report Writing

Business
report-writing

Report Writing is an Agent Skill for business published in the MODSetter/SurfSense repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

How to scope, draft, and revise a Markdown report artifact via generate_report

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/MODSetter/SurfSense/blob/HEAD/surfsense_backend/app/agents/chat/multi_agent_chat/main_agent/skills/builtin/report-writing/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/report-writing, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Report writing

When to use this skill

The user explicitly requests a deliverable: "write a report on …", "draft a memo", "produce a brief", "expand the previous report". A creation or modification verb pointed at an artifact is required (see generate_report's when-to-call rules).

Decision flow

  1. Source strategy. Decide which source_strategy fits:
    • conversation — substantive Q&A on the topic already in chat.
    • kb_search — fresh topic; supply 1–5 precise search_queries.
    • auto — partial conversation context; let the tool fall back.
    • provided — verbatim source text only.
  2. Style. Default to report_style="detailed" unless the user explicitly asks for "brief", "one page", "500 words".
  3. Revisions. When modifying an existing report from this conversation, set parent_report_id and put the change list in user_instructions ("add carbon-capture section", "tighten conclusion").
  4. Never paste the report back into chat after generate_report returns — confirm and let the artifact card render itself.

Hooks for KB-only mode

If kb_search/auto returns no results, do not silently switch to general knowledge. Surface the gap in your confirmation message.