Skip to content

Commit ac15486

Browse files
mldangeloclaude
andcommitted
docs: final copy edits and clarifications
- Remove interview-specific language from README - Use real UUID examples instead of <uuid> placeholders - Clarify Promptfoo testing setup instructions - Update package.json description to be more generic - Add helpful comments about token/sessionId in promptfoo config - Make response examples more realistic 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
1 parent c28dc25 commit ac15486

File tree

3 files changed

+14
-11
lines changed

3 files changed

+14
-11
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# RedScan Lite
22

3-
A simple chat API server for testing with Promptfoo - perfect for SE interviews.
3+
A simple chat API server designed for testing with Promptfoo.
44

55
## Getting Started
66

@@ -50,7 +50,7 @@ cd redscan-lite
5050
npm start
5151
```
5252

53-
The server will run at http://localhost:8080
53+
The server runs on http://localhost:8080
5454

5555
4. **Optional: Enable AI responses**
5656
```bash
@@ -68,15 +68,15 @@ The API requires authentication. Here's the complete flow:
6868
curl -X POST http://localhost:8080/auth
6969
```
7070

71-
Response: `{ "token": "<uuid>", "ttl": 300 }`
71+
Response: `{ "token": "550e8400-e29b-41d4-a716-446655440001", "ttl": 300 }`
7272

7373
### 2. Create a session
7474

7575
```bash
7676
curl -X POST http://localhost:8080/session
7777
```
7878

79-
Response: `{ "sessionId": "<uuid>" }`
79+
Response: `{ "sessionId": "660e8400-e29b-41d4-a716-446655440002" }`
8080

8181
### 3. Send messages
8282

@@ -90,14 +90,16 @@ curl -X POST http://localhost:8080/chat \
9090

9191
Response: `{ "message": "<response>", "usage": { "prompt_tokens": 10, "completion_tokens": 15, "total_tokens": 25 } }`
9292

93-
Note: If no session ID is provided, one will be created and returned in the `x-session-id` response header.
93+
**Note:** If no session ID is provided, one will be created and returned in the `x-session-id` response header.
9494

9595
## Testing with Promptfoo
9696

97-
Run Promptfoo evaluation:
97+
The included `promptfooconfig.yaml` is set up to test the API. You'll need to:
98+
99+
1. Get auth token and session ID from the API (see above)
100+
2. Update the config file with your values, or
101+
3. Use the echo provider for testing without the API
98102

99103
```bash
100104
promptfoo eval
101105
```
102-
103-
See `promptfooconfig.yaml` for configuration details.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "redscan-lite",
33
"version": "1.0.0",
4-
"description": "Target app for Promptfoo SE interviews",
4+
"description": "Simple chat API server for testing with Promptfoo",
55
"main": "index.js",
66
"scripts": {
77
"start": "node index.js"

promptfooconfig.yaml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,11 @@ description: RedScan Lite API Testing
33
prompts:
44
- "{{prompt}}"
55
providers:
6-
# Use this echo provider to test without needing authentication
6+
# Use the echo provider to test without needing authentication:
77
# - id: echo
88

9-
# Main provider - requires running the server locally
9+
# Main provider - requires the server running on localhost:8080
10+
# Before running: Replace {{token}} and {{sessionId}} with actual values from the API
1011
- id: http
1112
label: redscan-lite-api
1213
config:

0 commit comments

Comments
 (0)