tpmjs/packages/tools/official/json-path-query/README.md
Ajax Davis 5d2096fb5d feat: add 100+ official TPMJS tools
Implements a comprehensive suite of AI SDK v6 tools across multiple categories:

- Research (5): page-brief, compare-pages, source-credibility, claim-checklist, timeline-from-text
- Web (10): fetch-text, links-catalog, extract-meta, extract-json-ld, redirect-trace, sitemap-read, rss-read, table-extract, robots-policy, url-normalize
- Data (15): csv-parse, csv-stringify, json-repair, json-schema-validate, yaml-parse, yaml-stringify, text-chunk, normalize-whitespace, dedupe-by-key, pivot, rows-filter, rows-sort, rows-group-aggregate, rows-join, schema-infer
- Doc (12): toc-generate, glossary-build, faq-from-text, executive-brief, decision-record-adr, prd-outline, acceptance-criteria, style-rewrite
- Eng (12): diff-text-unified, env-var-docs-generate, dependency-audit-lite, conventional-commit-suggest, markdown-lint-basic, test-case-generate, stacktrace-parse, release-notes, changelog-entry, release-checklist
- Security (7): redact-secrets, secret-scan-text, url-risk-heuristic, csp-compose, hardening-checklist-web, access-control-matrix, data-classification-heuristic
- Stats (9): effect-size-suite, bootstrap-ci, permutation-test, multiple-testing-adjust, linear-regression-ols, logistic-regression, time-series-decompose-lite, anomaly-detect-mad
- Ops (7): slo-draft, runbook-draft, postmortem-draft, postmortem-action-extractor, error-log-triage, coverage-tracker, monitoring-gap-analysis
- Agent (15): prompt-to-workflow-skeleton, workflow-validate-io, workflow-explain, workflow-cost-estimate, tool-call-accuracy-score, eval-fixture-build, guardrail-policy-draft, workflow-auto-repair, tool-selection-plan, novelty-score-workflow, workflow-variant-generate, config-normalize, recipe-*
- Utility (8): base64-encode, base64-decode, hash-text, regex-extract, template-render, date-parse, json-path-query, url-parse
- HTML (3): html-sanitize, html-to-markdown, markdown-to-html

All tools follow AI SDK v6 pattern with tool() and jsonSchema<T>().

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-12-31 22:55:56 +10:00

1.3 KiB

@tpmjs/tools-json-path-query

Query JSON using JSONPath expressions.

Installation

npm install @tpmjs/tools-json-path-query

Usage

import { jsonPathQueryTool } from '@tpmjs/tools-json-path-query';

const data = {
  users: [
    { name: 'Alice', age: 25, active: true },
    { name: 'Bob', age: 17, active: false },
    { name: 'Carol', age: 30, active: true }
  ]
};

// Find all active users
const result = await jsonPathQueryTool.execute({
  json: data,
  path: '$.users[?(@.active)].name'
});

console.log(result.results);
// => ["Alice", "Carol"]

console.log(result.count);
// => 2

console.log(result.paths);
// => ["$['users'][0]['name']", "$['users'][2]['name']"]

JSONPath Examples

// Get all user names
path: '$.users[*].name'

// Find users older than 18
path: '$.users[?(@.age > 18)]'

// Recursive descent - find all 'price' fields
path: '$..price'

// Array slicing - first 3 items
path: '$.items[0:3]'

// Multiple conditions
path: '$.users[?(@.age > 18 && @.active)]'

Features

  • Powerful queries: Full JSONPath syntax support
  • Filtering: Filter arrays with expressions like ?(@.age > 18)
  • Recursive descent: Find nested values with ..
  • Path tracking: Returns the JSONPath to each result
  • Array operations: Slicing, filtering, and wildcard selection

License

MIT