TPSReport
approvedby Augmentable LLC
Sync Obsidian notes, research folders, and images with TPSReport AI Brain & Knowledge Management. Requires a HiFi-WP account. - This plugin has not been manually reviewed by Obsidian staff.
TPSReport — Obsidian Plugin
Sync your Obsidian vault to TPSReport — the optional authoring path for published knowledge bases and agent-ready retrieval.
TPSReport by Augmentable.ai — official Obsidian companion for TPSReport.
Publish structured knowledge bases · Power agentic workflows with metadata-rich retrieval · Optional: write in Obsidian and sync to the same KB contract.
Brand: TPSReport by Augmentable.ai
Home: tpsreport.pro · Plugin downloads: tpsreport.pro/downloads · Privacy: tpsreport.pro/privacy · Terms: tpsreport.pro/terms
What is TPSReport?
TPSReport is a workflow to publish knowledge bases and use them as an AI brain for agentic execution — not a note app or a generic chat wrapper.
Two layers:
| Layer | What it does |
|---|---|
| Publish KB | Codify expertise into linked reports and collections — visibility, gating, monetization |
| AI brain | Scoped retrieval with agent-oriented metadata — hybrid graph + vector, routing hints, negative signals |
You can build and ship 100% online. Obsidian is optional — popular for offline vaults, wikilinks, and folder-native authoring.
This plugin syncs vault folders into the same published KB and metadata contract:
- Write locally in Obsidian (or edit online and pull back)
- Publish folders as TPS Report collections
- Push/pull markdown, images, and agent-ready frontmatter
- Query and execute against your corpus in TPSReport
→ Install on tpsreport.pro/downloads · Skills & resources hub
→ Learn more about TPSReport · Use cases · FAQ
Why use this plugin?
| You want to… | TPSReport + Obsidian gives you… |
|---|---|
| Publish vault folders as structured KB reports | One-click Publish as New Report from any folder |
| Keep vault and cloud in sync | Bidirectional push/pull with stable node_id identity |
| Agent-ready retrieval metadata | YAML frontmatter (hyde_questions, retrieval_hint, defers_to, …) synced to Graph RAG |
| Validate before sync | Gatekeeper checks the metadata contract |
| Sync images with Markdown | Optional embedded image upload/download |
| Avoid silent overwrites | Conflict detection + reviewable conflict copies |
| Control visibility & destinations | Per-report visibility, edit scope, and account destinations |
Install
From Obsidian Community Plugins (recommended)
- Open Settings → Community plugins → Browse
- Search for TPSReport
- Install and enable
Official listing: community.obsidian.md/plugins/tpsreport-sync
Manual / beta install
Download main.js, manifest.json, and styles.css from the latest release.
Requires a free TPSReport account and an API key (obs_...) from your dashboard.
Quick start
- Sign up at tpsreport.pro
- Generate an API key in your TPSReport dashboard (
obs_...) - In Obsidian: Settings → TPSReport → paste key → Test Connection
- Right-click a vault folder → Publish as New Report
- Push, pull, and manage sync from the command palette or folder menu
Features
- Publish Obsidian folders as TPSReport knowledge reports
- Sync Markdown, nested folders, frontmatter, and local images
- Pull cloud updates back into mapped vault folders
- Preserve stable
node_idfrontmatter for ID-first reconciliation - Detect conflicts; create conflict copies instead of silent data loss
- Choose account-enabled report destinations
- Optionally enable RAG indexing for report content in your TPSReport knowledge base
AI generation, indexing, rendered report hosting, and access control run in your TPSReport cloud workspace — this plugin handles local ↔ cloud synchronization.
Configuration
Open Settings → TPSReport in Obsidian:
| Setting | Details |
|---|---|
| TPSReport API Key | Your obs_... key. Stored locally in plugin data. |
| Frontmatter ID field | Stable identity field (recommended: node_id). |
| Default report settings | Visibility, edit scope, content format, RAG, destination defaults. |
| Image sync | Upload embedded images on push; download on pull. |
| Folder mapping | Map vault folders to cloud TPSReport reports. |
Frontmatter for better retrieval
Add YAML properties to improve Graph RAG accuracy in TPSReport:
---
summary: Short retrieval-friendly summary of this note.
keywords: [product-name, category, region]
tags: [research, catalog]
intents: [product_lookup, business_recommendation]
entities: [Brand Name, Product SKU]
retrieval_hint: One sentence a search agent should match on.
---
Supported fields include summary, keywords, tags, intents, scenarios, entities, topics, brands, product_skus, audience, region, and more.
KB authoring skills & resources
TPSReport KB generation skill by Augmentable.ai — augmentableai/skills
| Resource | Link |
|---|---|
| Skills hub | skills/README.md |
| Install guide | skills/INSTALL.md |
| Workflow | skills/WORKFLOW.md |
| Examples | skills/examples/ |
| Canonical skill (SKILL.md) | tpsreport-knowledge-base-generation |
| Agent prompt template | KB_AGENT_PROMPT.md |
| Directory listing guide | skills/DIRECTORIES.md |
# Install skill (recommended)
npx skills add augmentableai/skills --skill tpsreport-knowledge-base-generation -y
The skill covers seed → write → RAG metadata → lint → push. The linter shares the same frontmatter contract as the plugin Gatekeeper.
Privacy & data handling
- No vault content is sent until you configure an API key and explicitly publish, push, or pull.
- API keys are stored locally in Obsidian and sent only to the TPSReport API.
- Synced content is governed by your report visibility settings in TPSReport.
Full policy: tpsreport.pro/privacy · Terms: tpsreport.pro/terms
Links
| Resource | URL |
|---|---|
| TPSReport home | tpsreport.pro |
| Plugin downloads (mirror) | tpsreport.pro/downloads |
| What is TPSReport? | docs/about-tpsreport.md |
| Use cases | docs/use-cases.md |
| FAQ | docs/faq.md |
| Plugin releases | GitHub Releases |
| Obsidian listing (official) | community.obsidian.md/plugins/tpsreport-sync |
| KB authoring skills hub | skills/ |
| Skills repo (canonical) | github.com/augmentableai/skills |
| skills.sh install | npx skills add augmentableai/skills --skill tpsreport-knowledge-base-generation -y |
| Privacy | tpsreport.pro/privacy |
| Terms | tpsreport.pro/terms |
| Support | arvind@augmentable.ai |
Keywords
Obsidian plugin · TPSReport by Augmentable.ai · knowledge management · Graph RAG · tpsreport.pro
License
MIT — see LICENSE.
Current version: 1.2.3 · Updates ship via GitHub releases tagged to match manifest.json.
For plugin developers
Search results and similarity scores are powered by semantic analysis of your plugin's README. If your plugin isn't appearing for searches you'd expect, try updating your README to clearly describe your plugin's purpose, features, and use cases.