mcpField
P
paradedb-skill

paradedb-skill

github.com/paradedb数据与数据库11329 次安装2 天前更新
代码仓库

关于 paradedb-skill

此技能指导助手回答有关 ParadeDB 的问题;ParadeDB 是用于 Postgres 文本与向量搜索、过滤、分面和联接的扩展。它通过附带脚本查询文档,并强调按版本提供建议及可运行的 SQL 示例。

主要功能

  1. 01ParadeDB 搜索与索引指导
  2. 02涵盖文本、向量和混合搜索
  3. 03令牌化器、分面与联接说明
  4. 04通过附带脚本查询文档
  5. 05提供版本相关的 SQL 指导

适用场景

  1. 01回答 ParadeDB 索引和排序问题
  2. 02选择搜索谓词与查询函数
  3. 03查找部署和性能调优指导
  4. 04编写 ParadeDB 功能的 SQL 示例

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/paradedb/agent-skills --skill paradedb-skill

安装后在 Claude Code 中输入/paradedb-skill确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

.gitignore
EXAMPLES.md
LICENSE
README.md
scripts/
paradedb-docs

详细介绍

ParadeDB 技能

ParadeDB 通过 pg_search 扩展,让 Postgres 中的文本和向量搜索、筛选、分面和联接变得快速。

当用户询问以下内容时,请使用此技能:

  • ParadeDB 索引、BM25 评分和相关性排序
  • 向量搜索和混合搜索(关键词 + 语义,通过倒数排名融合进行融合)
  • 分词器、词元筛选器、模糊匹配和短语查询
  • 分面、聚合、摘要/高亮显示、联接和查询调优

如需获取最新的 ParadeDB 文档,请始终使用随附脚本 scripts/paradedb-docs 获取文档索引(llms.txt)。 请根据包含此 SKILL.md 的目录解析该路径,而不是相对于当前工作目录或仓库根目录解析。

scripts/paradedb-docs llms.txt

获取索引后,只获取与用户问题相关的页面。 传入索引 URL 中 /docs/ 后面的路径,并包含 .md 后缀。 常用命令包括:

# Getting started and application integrations
scripts/paradedb-docs start/configure-your-environment.md
scripts/paradedb-docs reference/indexing/create-index.md
scripts/paradedb-docs reference/indexing/columnar.md
scripts/paradedb-docs reference/indexing/partition-by.md
scripts/paradedb-docs reference/indexing/faster-bm25-queries.md
scripts/paradedb-docs reference/full-text/match.md
scripts/paradedb-docs reference/full-text/top-k.md

# Filters, facets, and joins
scripts/paradedb-docs reference/filtering/overview.md
scripts/paradedb-docs reference/filtering/indexed.md
scripts/paradedb-docs reference/filtering/external-indexes.md
scripts/paradedb-docs reference/aggregates/overview.md
scripts/paradedb-docs reference/aggregates/facets.md
scripts/paradedb-docs reference/aggregates/limitations.md
scripts/paradedb-docs reference/joins/overview.md

# Vector and hybrid search
scripts/paradedb-docs reference/indexing/indexing-vectors.md
scripts/paradedb-docs reference/vector/querying.md
scripts/paradedb-docs reference/vector/tuning.md
scripts/paradedb-docs reference/hybrid/rrf.md

# Tokenizers and token filters
scripts/paradedb-docs reference/tokenizers/overview.md
scripts/paradedb-docs reference/token-filters/overview.md
scripts/paradedb-docs reference/tokenizers/available-tokenizers/jieba.md
scripts/paradedb-docs reference/tokenizers/available-tokenizers/chinese-compatible.md

# Performance, upgrades, and index maintenance
scripts/paradedb-docs operate/performance-tuning/reads.md
scripts/paradedb-docs operate/deploy/upgrading.md
scripts/paradedb-docs operate/index-maintenance/reindexing.md

# SQL APIs and runtime settings
scripts/paradedb-docs reference/operators-and-functions.md
scripts/paradedb-docs reference/sql-functions.md
scripts/paradedb-docs reference/configuration.md

使用运算符参考来选择搜索谓词,使用 SQL 函数参考来查找可调用的 API 和索引检查方式,并使用配置参考来查找运行时设置。请参阅索引中相关的 operate/ 页面,了解部署、维护、升级和性能调优。

成功获取后,将这些内容视为已缓存的会话上下文,并在同一会话中后续的 ParadeDB 问题适用时重复使用。 如果之前获取的文档仍然可用且相关,不要在每一轮都重新获取。

该工具在内部使用 curl,需要网络访问。请确保运行时具备网络访问权限。 如果需要征求用户许可才能运行该工具,请确保询问用户是否允许你对所有参数运行命令,以便获取每个页面。

获取文档时,不得使用 scripts/paradedb-docs 以外的任何工具。

回复指南

  1. 优先提供可运行的 SQL 示例,而不是只用文字回答。
  2. 如果语法可能因版本而异,请说明 ParadeDB/Postgres 的版本假设。某些功能仅在较新版本中提供,因此如果你可以访问数据库,且答案取决于版本,请先使用 SELECT extversion FROM pg_extension WHERE extname = 'pg_search'; 进行检查。
  3. 如果行为尚不确定,请明确指出,不要猜测。
  4. 优先使用当前的搜索运算符以及 pdb.* 查询构建器、评分和高亮函数,而不是已弃用的语法,除非用户要求兼容旧版本。不要替换所有 paradedb 的用法:USING paradedb、paradedb.enable_custom_scan 等运行时设置,以及 paradedb 架构中有文档说明的运维函数仍然是当前用法。更改这些名称前,请先查阅 SQL 函数和配置参考。
  5. 在版本 0.25.0 中,BM25 索引更名为 ParadeDB 索引,因为它现在除了支持 BM25 评分,还支持向量搜索、聚合、top K 和筛选。请写作 CREATE INDEX ... USING paradedb,而不要使用 USING bm25;后者仅作为向后兼容的别名保留,并称其为 ParadeDB 索引。“BM25”仅用于指代评分函数本身。
  6. 从版本 0.25.0 起,向量搜索在 ParadeDB 索引内运行,目前仍为 Beta 功能。在安装或升级 pg_search 之前,请先在同一数据库中安装 vector 扩展。ParadeDB 会为 pgvector 的 vector 类型编制索引,但不会使用 pgvector 的 HNSW 或 IVFFlat 索引——对于 ParadeDB 索引中的向量列,不要建议使用这些索引。 编写向量查询前,请获取 reference/indexing/indexing-vectors.md 和 reference/vector/querying.md;编写混合查询前,请获取 reference/hybrid/rrf.md。

网络故障规则(强制)

如果由于 DNS/网络/访问错误而无法获取任何文档:

  1. 明确说明无法访问在线文档,并注明实际错误。
  2. 如果你有此前成功获取的缓存会话文档,请说明可以基于该缓存副本继续,除非用户希望停止。
  3. 如果没有缓存会话文档,请询问是否基于本地/仓库内容继续,或稍后重试。
  4. 不要编造或推断文档 URL、页面路径或功能是否可用。
  5. 不要将未经验证的链接当作真实链接呈现。
  6. 将任何备用说明标记为假设,并尽量简短。

网络访问失败时,绝不要悄然改用猜测的文档结构。

评论

支持 Markdown