@@ -15,13 +15,78 @@ The OpenAPI source defaults to:
1515https://raw.githubusercontent.com/formkiq/formkiq-core/refs/heads/master/docs/openapi/openapi-jwt.yaml
1616```
1717
18+ ## Quick Start
19+
20+ The most common setup is to let your MCP client start this server with ` pipx ` from GitHub.
21+
22+ Use the FormKiQ CloudFormation ` HttpApiUrl ` output for JWT/Cognito authentication:
23+
24+ ``` bash
25+ aws cloudformation describe-stacks \
26+ --stack-name " <formkiq-stack-name>" \
27+ --query " Stacks[0].Outputs[?OutputKey=='HttpApiUrl'].OutputValue | [0]" \
28+ --output text
29+ ```
30+
31+ Replace the example endpoint and JWT values in the client config snippets below.
32+
33+ ### Codex Setup
34+
35+ Add this to ` ~/.codex/config.toml ` or to a trusted project's ` .codex/config.toml ` :
36+
37+ ``` toml
38+ [mcp_servers .formkiq ]
39+ command = " pipx"
40+ args = [" run" , " --spec" , " git+https://github.com/formkiq/formkiq-mcp-server.git" , " formkiq-mcp-server" ]
41+ env = { "MCP_TRANSPORT" = " stdio" , "FORMKIQ_API_ENDPOINT_URL" = " https://abc123.execute-api.us-east-1.amazonaws.com" , "FORMKIQ_JWT" = " eyJ..." }
42+ startup_timeout_sec = 30
43+ tool_timeout_sec = 60
44+ enabled = true
45+ ```
46+
47+ Start a new Codex session and check:
48+
49+ ``` text
50+ /mcp
51+ ```
52+
53+ ### Claude Code Setup
54+
55+ Add the server from the CLI:
56+
57+ ``` bash
58+ claude mcp add --transport stdio formkiq \
59+ --env FORMKIQ_API_ENDPOINT_URL=https://abc123.execute-api.us-east-1.amazonaws.com \
60+ --env FORMKIQ_JWT=eyJ... \
61+ --env MCP_TRANSPORT=stdio \
62+ -- pipx run --spec git+https://github.com/formkiq/formkiq-mcp-server.git formkiq-mcp-server
63+ ```
64+
65+ Then check:
66+
67+ ``` bash
68+ claude mcp list
69+ ```
70+
71+ Inside Claude Code, use:
72+
73+ ``` text
74+ /mcp
75+ ```
76+
1877## Requirements
1978
2079- Python 3.11+
21- - ` uv `
80+ - ` pipx ` for GitHub-backed MCP client setup, or ` uv ` for local development
2281- a deployed FormKiQ API endpoint URL from the FormKiQ CloudFormation outputs
2382- a FormKiQ JWT for API calls
2483
84+ Install ` pipx ` if needed:
85+
86+ ``` bash
87+ brew install pipx
88+ ```
89+
2590Install ` uv ` if needed:
2691
2792``` bash
@@ -221,36 +286,9 @@ For request bodies:
221286}
222287```
223288
224- ## Codex Setup
289+ ## Local Codex Development Setup
225290
226- Codex supports MCP servers in ` config.toml ` .
227-
228- For a GitHub-backed setup similar to common ` pipx ` MCP servers, add this to ` ~/.codex/config.toml ` or to a trusted project's ` .codex/config.toml ` :
229-
230- ``` toml
231- [mcp_servers .formkiq ]
232- command = " pipx"
233- args = [
234- " run" ,
235- " --spec" ,
236- " git+https://github.com/formkiq/formkiq-mcp-server.git" ,
237- " formkiq-mcp-server" ,
238- ]
239- env = { "MCP_TRANSPORT" = " stdio" , "FORMKIQ_API_ENDPOINT_URL" = " https://abc123.execute-api.us-east-1.amazonaws.com" , "FORMKIQ_JWT" = " eyJ..." }
240- startup_timeout_sec = 30
241- tool_timeout_sec = 60
242- enabled = true
243- enabled_tools = [
244- " list_formkiq_operations" ,
245- " call_formkiq_operation" ,
246- " get_version" ,
247- " get_documents" ,
248- " get_document" ,
249- " search_documents" ,
250- ]
251- ```
252-
253- For local development from a checkout, use ` uv ` instead:
291+ For local development from a checkout, use ` uv ` in ` ~/.codex/config.toml ` or in a trusted project's ` .codex/config.toml ` :
254292
255293``` toml
256294[mcp_servers .formkiq ]
@@ -286,19 +324,9 @@ codex mcp list
286324
287325Codex MCP configuration reference: https://developers.openai.com/codex/mcp
288326
289- ## Claude Code Setup
290-
291- Claude Code can add a local stdio server from the CLI:
292-
293- ``` bash
294- claude mcp add --transport stdio formkiq \
295- --env FORMKIQ_API_ENDPOINT_URL=https://abc123.execute-api.us-east-1.amazonaws.com \
296- --env FORMKIQ_JWT=eyJ... \
297- --env MCP_TRANSPORT=stdio \
298- -- uv --directory /Users/you/Documents/github/formkiq-mcp-server run python server.py
299- ```
327+ ## Claude Code Project Setup
300328
301- For a project-shared setup, add a ` .mcp.json ` file to your project:
329+ For a project-shared Claude Code setup from a local checkout , add a ` .mcp.json ` file to your project:
302330
303331``` json
304332{
0 commit comments