igorrendulic/codex-couchdb-toolkit

Letzte erfasste Quellaktivität: 1. Juli 2026 um 03:44

SkillsMP-Katalog aktualisiert: 2. November 2026 um 18:02

gesammelte Skills: 1

GitHub-Stars: 2
GitHub-Forks: 0

Mit einem KI-Assistenten installieren

Diesen Prompt kopieren und in den verwendeten KI-Assistenten einfügen.

Follow https://skillsmp.com/skill-install/prompt.md to install Agent Skills from https://github.com/igorrendulic/codex-couchdb-toolkit.

README des Repositorys

README-Quelldatei: README.md

README-Quelldatei lesen

Vollständige README anzeigen

# Codex CouchDB Toolkit A Codex plugin/skill for investigating CouchDB-backed application state using your repo's own lookup code, read-first database access, and structured JSON outputs. ## What It Includes - A `couchdb-agent` CLI for profile setup and local recipe management. - A stdio MCP server that exposes conservative, read-only CouchDB tools to Codex. - A Codex skill for combining CouchDB records with repository code inspection. - A local installer for development from a checkout. ## Requirements - Node.js 20 or newer. - npm. - Codex CLI, when using the MCP server or plugin. - macOS keychain access for stored CouchDB profile passwords. ## Installation ```bash npm install -g codex-couchdb-toolkit ``` Register the MCP server with Codex using the installed `couchdb-agent` command: ```bash codex mcp add codex-couchdb-toolkit -- couchdb-agent mcp ``` The npm package is published at <https://www.npmjs.com/package/codex-couchdb-toolkit>. ## Configure A Profile ```bash printf '%s' 'password' | couchdb-agent login \ --profile prod-readonly \ --url https://couch.example.test \ --username igor \ --password-stdin ``` Secrets are stored in the macOS keychain. Non-secret profile metadata and recipe memory are stored in `~/.config/couchdb-agent/config.json`. ## How To Use ### 1. Confirm the CLI can reach CouchDB After login, run: ```bash couchdb-agent profiles list couchdb-agent db-list ``` Both commands print JSON. `profiles list` shows the active profile. `db-list` proves the active profile can read from CouchDB. ### 2. Start an investigation from Codex Open Codex in the application repository you want to investigate, then ask a normal question and mention CouchDB. For example: ```text Use the CouchDB investigation skill. Find the user record for user id USER_ID, inspect this repo's lookup code, and explain what state the database currently has. Return structured JSON with evidence. ``` Useful prompt shape: ```text Use CouchDB to investigate <thing I am debugging>. First inspect the repo code that creates or looks up this data. Then query CouchDB read-only and return JSON evidence. ``` Codex should use the `couchdb-investigate` skill and the `codex-couchdb-toolkit` MCP server. The toolkit is read-only: it can list databases, read documents, check document existence, run Mango find queries, query views, and make relative raw GET requests. ### 3. Reuse investigation recipes If you repeat the same kind of lookup, save the pattern: ```bash couchdb-agent recipes save \ --label "Find user by app id" \ --description "Inspect user id lookup code, then query the user database by derived CouchDB id." \ --database users \ --code-anchor src/path/to/lookup.ts \ --step "Find the code path that derives the CouchDB document id" \ --step "Check the expected document with doc_head_or_exists, then doc_get" ``` Later, Codex can suggest matching recipes during investigations. Recipes should store only the workflow, not returned records, secrets, or payloads. ## Development ```bash npm install npm run typecheck npm test npm run build ``` ### Local Installation From A Checkout Install the CLI, Codex MCP server, and local Codex plugin from this checkout: ```bash npm run install:local ``` This builds the package, runs `npm link` for the `couchdb-agent` command, registers the MCP server with an absolute path to this checkout, and installs the plugin from the personal local marketplace. For narrower local installs: ```bash npm run install:local:cli node scripts/install-local.mjs --dry-run node scripts/install-local.mjs --skip-mcp node scripts/install-local.mjs --skip-plugin ``` To register the MCP server manually from a checkout instead of using the local installer: ```bash codex mcp add codex-couchdb-toolkit -- node "$(pwd)/dist/cli.js" mcp ``` The plugin skill lives at `skills/couchdb-investigate/SKILL.md`. ## Publish Publishing is handled by the GitHub release workflow when a version tag is pushed. Configure npm Trusted Publishing for this package before pushing the tag: - Publisher: GitHub Actions - Organization or user: `igorrendulic` - Repository: `codex-couchdb-toolkit` - Workflow filename: `release.yml` - Allowed action: `npm publish` - Environment name: leave blank Then create and push a tag that matches the package version: ```bash git tag v0.1.0 git push origin v0.1.0 ``` The workflow runs typecheck, tests, build, `npm pack --dry-run`, and then publishes to npm with Trusted Publishing. npm automatically generates provenance for public packages published from public GitHub repositories. If npm does not let you configure Trusted Publishing before the package exists, publish the first version manually from a logged-in local npm account, then configure Trusted Publishing for later versions. ## License MIT

README des Repositorys wird geladen…

Skills in diesem Repository

Softwareentwickler

1 Berufskategorien · 100% klassifiziert

Skill

Beruf

Beschreibung

Aktualisiert

couchdb-investigate

Softwareentwickler

Use for read-only CouchDB investigations that combine database records, current repository code, and reusable analytics/query recipes.

Quellsprache: Englisch

2026-07-01

Es werden 1 von 1 gesammelten Skills angezeigt.