Add SEO examples structure — Part 5 of seo-public-surfaces task - #11
Merged
Conversation
Restructures README.md and adds an examples/ directory with five self-contained integration examples, each with its own SEO-optimised sub-README, working code, and links to planvault.ai/docs|api-docs|security. README.md: - H1: "PlanVault Integration Examples: Connect AI Agents to Production APIs" - "Why governed AI execution matters" (fault tolerance, BYOK, HITL) - Examples section linking to each sub-directory - Self-hosted deployment section - "Getting started in 2 days" with links to /docs, /api-docs, /security - Existing reference implementations table and full API reference preserved examples/01-openapi-import/ - README: "Connect Any REST API to AI Agents via OpenAPI Import" - openapi-sample.yaml: Task Management API (3 operations, full schemas) examples/02-langgraph-webhook/ - README: "Trigger a LangGraph Agent via PlanVault Webhook" - webhook_handler.py: FastAPI bridge exposing LangGraph as a PlanVault tool examples/03-mcp-host-nodejs/ - README: "Build a Secure MCP Host with Node.js and PlanVault" - index.ts: stdio MCP server with get_record / list_records tools - package.json + tsconfig.json for build examples/04-hitl-approval-gate/ - README: "Add Human-in-the-Loop Approval Gates to AI Tool Calls" - tool_with_approval.py: FastAPI tool server with blocking approval queue examples/05-n8n-integration/ - README: "Use PlanVault as a Governed AI Execution Step in n8n Workflows" - n8n-workflow.json: importable workflow (webhook → session → poll → respond) - planvault-node.js: Code node snippet for session create/send/poll in one node Co-authored-by: Cursor <cursoragent@cursor.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Implements Part 5 of
docs/todo/seo-public-surfaces-faq-schema-examples-repo.mdin full.README.md restructured (Part 5.1)
# PlanVault Integration Examples: Connect AI Agents to Production APIs(contains target keywords)planvault.ai/security/docs,/api-docs,/securityexamples/ directory created (Part 5.2)
01-openapi-import/openapi-sample.yaml(Task Management API, 3 operations, full schemas)02-langgraph-webhook/webhook_handler.py(FastAPI bridge, LangGraph stub with real invocation comment)03-mcp-host-nodejs/index.ts(MCP stdio server,get_record+list_records) +package.json+tsconfig.json04-hitl-approval-gate/tool_with_approval.py(blocking FastAPI tool with approve/reject endpoint)05-n8n-integration/n8n-workflow.json(importable, webhook→session→poll loop) +planvault-node.js(Code node snippet)Each sub-README contains: own H1 with search phrase, problem statement (2–3 sentences), working code snippet, "How it works" section, and links to
planvault.ai/docs,/api-docs,/security.SEO checklist (from task)
LangGraph webhook,MCP host,approval gate,n8n workflow)planvault.ai/docs,/api-docs,/securityTest plan
examples/05-n8n-integration/n8n-workflow.jsoninto a local n8n instance; verify all nodes resolvecd examples/03-mcp-host-nodejs && npm install && npx tsc— compiles without errorspython examples/02-langgraph-webhook/webhook_handler.py— starts on port 8000python examples/04-hitl-approval-gate/tool_with_approval.py— starts on port 8001