Skip to content

Add AGENTS.md with Cursor Cloud development instructions#6

Open
aavramch wants to merge 1 commit into
mainfrom
cursor/setup-dev-environment-afb9
Open

Add AGENTS.md with Cursor Cloud development instructions#6
aavramch wants to merge 1 commit into
mainfrom
cursor/setup-dev-environment-afb9

Conversation

@aavramch
Copy link
Copy Markdown
Owner

@aavramch aavramch commented May 23, 2026

Summary

Adds AGENTS.md with Cursor Cloud-specific development instructions so future cloud agents can quickly set up and run the Reparsed API locally.

What's included

  • Instructions for starting PostgreSQL and the FastAPI dev server locally (without Docker)
  • Key caveats: graceful Ollama degradation, Playwright toggle, session cookie security, auto-created tables
  • Quick validation endpoints for smoke-testing

Development environment verification

The full development environment was set up and verified end-to-end:

  • PostgreSQL 16 running locally with reparsed user/database
  • Python 3.12 with all dependencies from requirements.txt
  • Playwright Chromium browser installed
  • FastAPI dev server running on port 17177 with hot reload

Demo

demo_reparsed_registration_and_dashboard.mp4

End-to-end flow: landing page, registration, dashboard, API key generation.

Landing page
Dashboard with API key

API tests

All core endpoints verified:

  • GET /healthz — 200 OK
  • GET /v1/health — returns model status
  • GET /v1/content-types — lists all content types
  • POST /register — user registration
  • POST /dashboard/api/keys — API key generation
  • POST /v1/parse — text parsing with graceful LLM fallback

To show artifacts inline, enable in settings.

Open in Web Open in Cursor 

Summary by CodeRabbit

  • Documentation
    • Added comprehensive developer setup guide including deployment instructions, configuration requirements, and service endpoints for validation.

Review Change Stack

Co-authored-by: Alex <aavramch@users.noreply.github.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 23, 2026

📝 Walkthrough

Walkthrough

Added AGENTS.md documentation file providing Cursor Cloud agent instructions for the Reparsed FastAPI service. Content covers dev environment setup (PostgreSQL, server startup), required and optional environment variables, operational assumptions and caveats, and a list of key endpoints for validation.

Changes

Agent Instructions

Layer / File(s) Summary
Cursor Cloud Agent Instructions
AGENTS.md
Added documentation describing dev startup commands (PostgreSQL and FastAPI server), required environment variables (database URL, session secret) and optional settings (Ollama base URL, Playwright toggle), key caveats (graceful behavior without Ollama, auto table creation, session cookie security), and a quick list of endpoints for validation.

🎯 1 (Trivial) | ⏱️ ~3 minutes

🐰 New docs so fine, our agent friends can align,
Endpoints, envars, and notes to combine,
From postgres to plumbing, all ready to shine!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately and clearly describes the main change: adding AGENTS.md documentation with Cursor Cloud development instructions.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch cursor/setup-dev-environment-afb9

Comment @coderabbitai help to get the list of available commands and usage tips.

@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages Bot commented May 23, 2026

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Updated (UTC)
🚫 Deployment cancelled
View logs
reparsed c2bc177 May 23 2026, 06:39 AM

@aavramch aavramch marked this pull request as ready for review May 23, 2026 06:46
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@AGENTS.md`:
- Around line 12-23: The two fenced code blocks in AGENTS.md (the one containing
"sudo pg_ctlcluster 16 main start" and the multi-line uvicorn/DATABASE_URL
block) lack surrounding blank lines and language identifiers; update each fenced
block to have a blank line before and after and add the appropriate language tag
(e.g., ```bash) so the pg_ctlcluster single-line block and the uvicorn
environment/command block are fenced as ```bash with blank-line spacing around
them.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 630615d4-bce3-4b18-ab4e-594ee23b5d13

📥 Commits

Reviewing files that changed from the base of the PR and between 1f5073c and c2bc177.

📒 Files selected for processing (1)
  • AGENTS.md

Comment thread AGENTS.md
Comment on lines +12 to +23
```
sudo pg_ctlcluster 16 main start
```

2. **Start FastAPI with uvicorn** from the `api/` directory:
```
DATABASE_URL="postgresql+asyncpg://reparsed:reparsed@localhost:5432/reparsed" \
SESSION_SECRET="dev-secret-for-local-testing-only-32b" \
OLLAMA_BASE_URL="http://localhost:11434" \
PLAYWRIGHT_ENABLED=false \
uvicorn app.main:app --host 0.0.0.0 --port 17177 --reload
```
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Add Markdown fence languages and blank-line spacing around fenced blocks.

The fenced blocks on Line 12 and Line 17 violate MD031/MD040. Add surrounding blank lines and explicit language identifiers.

📄 Proposed doc fix
 1 # AGENTS.md
 2 
 3 ## Cursor Cloud specific instructions
 4 
 5 ### Overview
 6 
 7 Reparsed is a single-service Python 3.12 FastAPI application that parses files and URLs into clean, structured, LLM-ready text. It requires PostgreSQL 16 for persistence and optionally connects to an external Ollama server for LLM classification.
 8 
 9 ### Running the dev server
10 
11 1. **Start PostgreSQL** (if not already running):
-12    ```
+12
+    ```bash
13    sudo pg_ctlcluster 16 main start
14    ```
15 
16 2. **Start FastAPI with uvicorn** from the `api/` directory:
-17    ```
+17
+    ```bash
18    DATABASE_URL="postgresql+asyncpg://reparsed:reparsed@localhost:5432/reparsed" \
19    SESSION_SECRET="dev-secret-for-local-testing-only-32b" \
20    OLLAMA_BASE_URL="http://localhost:11434" \
21    PLAYWRIGHT_ENABLED=false \
22    uvicorn app.main:app --host 0.0.0.0 --port 17177 --reload
23    ```
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)

[warning] 12-12: Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)


[warning] 12-12: Fenced code blocks should have a language specified

(MD040, fenced-code-language)


[warning] 17-17: Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)


[warning] 17-17: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@AGENTS.md` around lines 12 - 23, The two fenced code blocks in AGENTS.md (the
one containing "sudo pg_ctlcluster 16 main start" and the multi-line
uvicorn/DATABASE_URL block) lack surrounding blank lines and language
identifiers; update each fenced block to have a blank line before and after and
add the appropriate language tag (e.g., ```bash) so the pg_ctlcluster
single-line block and the uvicorn environment/command block are fenced as
```bash with blank-line spacing around them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants