Skip to content

Commit 604c5e4

Browse files
committed
refactor(docs): add README getting started
1 parent 38e160e commit 604c5e4

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,44 @@ Live documentation: https://genentech.github.io/penrose-lamarck/
44

55
## Getting Started
66

7+
```sh
8+
❯ codex
9+
⚠ The penroselamarck MCP server is not logged in. Run `codex mcp login penroselamarck`.
10+
11+
⚠ MCP startup incomplete (failed: penroselamarck)
12+
```
13+
714
```sh
815
❯ codex mcp list
916
Name Url Bearer Token Env Var Status Auth
1017
penroselamarck http://penroselamarck-api:8080/v1/mcp/sse - enabled OAuth
18+
```
1119

20+
```sh
1221
❯ codex mcp login penroselamarck
22+
Authorize `penroselamarck` by opening this URL in your browser:
23+
https://...
24+
1325
Successfully logged in to MCP server 'penroselamarck'.
26+
```
1427

28+
```sh
1529
❯ codex
30+
/mcp
31+
32+
🔌 MCP Tools
33+
34+
• penroselamarck
35+
• Status: enabled
36+
• Auth: OAuth
37+
• URL: http://penroselamarck-api:8080/v1/mcp/sse
38+
• Tools: auth_login, auth_me, exercise_create, exercise_list, metrics_performance, practice_end, practice_next, practice_start, practice_submit, study_context_get, study_context_set, train_import
39+
• Resources: (none)
40+
• Resource templates: (none)
41+
```
42+
43+
```sh
44+
❯ codex mcp logout penroselamarck
1645
```
1746

1847
## Contributing

0 commit comments

Comments
 (0)