@realtimex/sdk 1.5.1 → 1.7.0

package/skills/realtimex-moderator-sdk/references/credentials.md

@@ -0,0 +1,111 @@
+# Credentials Reference
+
+Credentials are managed by the user in **Settings > Credentials**. Agents have read-only access via `sdk.credentials`.
+
+## Security Rules
+
+1. **Never** print credential values to stdout (they become tool results in chat history)
+2. **Never** include credential values in your response text
+3. **Never** write credential values to files or logs
+4. **Never** pass credential values as CLI arguments (visible in process list)
+5. **Always** consume credentials inside scripts — fetch, use, discard
+6. **Always** call `process.exit(0)` at the end of custom scripts (prevents hanging on open HTTP sockets)
+7. **Never** write helper scripts into the SKILL directory — use the working directory or system temp
+
+## Credential Types
+
+| Type | Payload | How to Apply |
+|------|---------|-------------|
+| `http_header` | `{ name, value }` | Set as HTTP header: `headers[payload.name] = payload.value` |
+| `query_auth` | `{ name, value }` | Append to URL: `?${payload.name}=${payload.value}` |
+| `basic_auth` | `{ username, password }` | Encode: `Authorization: Basic ${btoa(username + ":" + password)}` |
+| `env_var` | `{ name, value }` | Set in subprocess: `env[payload.name] = payload.value` |
+
+## Usage Patterns
+
+### List available credentials
+
+```bash
+node "$SKILL" credentials
+```
+
+Output: table of names and types (no values).
+
+### Important: credential payload structure
+
+`sdk.credentials.get(name)` returns `{ name, type, payload }`. The `payload` object contains structured fields — use them directly. **Never** extract raw values and construct headers manually.
+
+### Use an http_header credential in a script
+
+```javascript
+const { initSDK } = require('<SKILL_DIR>/scripts/lib/sdk-init');
+(async () => {
+  const { sdk } = await initSDK();
+  const cred = await sdk.credentials.get('github-token');
+  // cred.type === "http_header"
+  // cred.payload === { name: "Authorization", value: "Bearer ghp_xxx" }
+  // The value already includes the full header value — use as-is
+  const res = await fetch('https://api.github.com/user', {
+    headers: { [cred.payload.name]: cred.payload.value }
+  });
+  console.log('Status:', res.status); // Only non-sensitive output
+  process.exit(0);
+})();
+// WRONG: const token = cred.payload.value; headers.Authorization = `Bearer ${token}`
+// The value already contains "Bearer ..." — adding prefix again causes 401
+```
+
+### Use a basic_auth credential
+
+```javascript
+const { initSDK } = require('<SKILL_DIR>/scripts/lib/sdk-init');
+(async () => {
+  const { sdk } = await initSDK();
+  const cred = await sdk.credentials.get('registry-login');
+  const auth = Buffer.from(cred.payload.username + ':' + cred.payload.password).toString('base64');
+  const res = await fetch('https://registry.example.com/v2/_catalog', {
+    headers: { 'Authorization': 'Basic ' + auth }
+  });
+  console.log('Status:', res.status);
+  process.exit(0);
+})();
+```
+
+### Use an env_var credential with a subprocess
+
+```javascript
+const { initSDK } = require('<SKILL_DIR>/scripts/lib/sdk-init');
+const { execSync } = require('child_process');
+(async () => {
+  const { sdk } = await initSDK();
+  const cred = await sdk.credentials.get('aws-key');
+  // cred.type === "env_var"
+  // cred.payload === { name: "AWS_ACCESS_KEY_ID", value: "AKIA..." }
+  execSync('aws s3 ls', {
+    env: { ...process.env, [cred.payload.name]: cred.payload.value },
+    stdio: 'inherit'
+  });
+  process.exit(0);
+})();
+```
+
+### Error handling
+
+```javascript
+const { initSDK } = require('<SKILL_DIR>/scripts/lib/sdk-init');
+(async () => {
+  try {
+    const { sdk } = await initSDK();
+    const cred = await sdk.credentials.get('my-key');
+    // use cred...
+    process.exit(0);
+  } catch (err) {
+    if (err.message.includes('not found')) {
+      console.log('Credential not found. Ask the user to add it in Settings > Credentials.');
+    } else {
+      console.log('Error:', err.message);
+    }
+    process.exit(1);
+  }
+})();
+```

package/skills/realtimex-moderator-sdk/references/known-issues.md

@@ -1,6 +1,6 @@
 # Known Issues — Source-Detected
 
-> Auto-generated by `scripts/generate-skill.mjs` · SDK **1.5.1** · 2026-04-02
+> Auto-generated by `scripts/generate-skill.mjs` · SDK **1.7.0** · 2026-04-16
 
 Run `node scripts/generate-skill.mjs --force` after SDK source changes to refresh.
 

package/skills/realtimex-moderator-sdk/scripts/lib/sdk-init.js

@@ -8,7 +8,7 @@
  *   2. ~/.realtimex.ai/.sdk-app-id file (written by RealtimeX server)
  *   3. RTX_APP_ID in process.env (injected by RealtimeX for local apps)
  *   4. RTX_API_KEY in process.env (standalone dev)
- *   5. REALTIMEX_API_KEY / REALTIMEX_AI_API_KEY in <envDir>/.env (standalone dev)
+ *   5. RTX_API_KEY in <envDir>/.env (standalone dev)
  *   6. Interactive readline prompt (fallback)
  */
 

package/skills/realtimex-moderator-sdk/scripts/rtx.js

@@ -304,6 +304,13 @@ CMD['mcp-exec'] = async () => {
   print(await sdk.mcp.executeTool(server, tool, argsStr ? JSON.parse(argsStr) : {}, flags.provider));
 };
 
+// -- credentials ------------------------------------------------------------
+CMD['credentials'] = async () => {
+  const { sdk } = await getSDK();
+  const list = await sdk.credentials.list();
+  printTable(list, ['name', 'type']);
+};
+
 // -- acp-agents -------------------------------------------------------------
 // Source: AcpAgentModule.listAgents({ includeModels? })
 // Returns: AcpAgentInfo[] { id, label, handles[], installed, authReady, status }
@@ -797,6 +804,10 @@ sdk.mcp.*:
   mcp-tools <server> [--provider]
   mcp-exec <server> <tool> [<args-json>] [--provider]
 
+sdk.credentials.*:
+  credentials
+    List available credentials (names and types, no values).
+
 sdk.acpAgent.* — Session Management:
   acp-agents [--models=true]
     List available ACP CLI agents.
@@ -871,8 +882,10 @@ sdk.database.* / sdk.auth.*:
     console.error('Unknown command: ' + (command || '(none)') + '\nRun: node rtx.js help');
     process.exit(1);
   }
-  try { await handler(); }
-  catch (err) {
+  try {
+    await handler();
+    process.exit(0);
+  } catch (err) {
     console.error('Error:', err.message || err);
     if (flags.debug) console.error(err);
     process.exit(1);