formatSearchResultsWithPagination() — ui Function Reference

Architecture documentation for the formatSearchResultsWithPagination() function in utils.ts from the ui codebase.

Function typescript FrameworkTooling TemplateSync calls 1

Entity Profile

FrameworkTooling→ TemplateSync→ formatSearchResultsWithPagination() — ui Function Reference

Dependency Diagram

graph TD
  e074f76b_0b62_9768_d746_68aa9efd9605["formatSearchResultsWithPagination()"]
  7f4634ea_efbc_d613_10b1_f8b135d63ff3["utils.ts"]
  e074f76b_0b62_9768_d746_68aa9efd9605 -->|defined in| 7f4634ea_efbc_d613_10b1_f8b135d63ff3
  4ffcf92a_16a8_9594_042e_84887be4f0f7["npxShadcn()"]
  e074f76b_0b62_9768_d746_68aa9efd9605 -->|calls| 4ffcf92a_16a8_9594_042e_84887be4f0f7
  style e074f76b_0b62_9768_d746_68aa9efd9605 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

packages/shadcn/src/mcp/utils.ts lines 23–79

export function formatSearchResultsWithPagination(
  results: z.infer<typeof searchResultsSchema>,
  options?: {
    query?: string
    registries?: string[]
  }
) {
  const { query, registries } = options || {}

  const formattedItems = results.items.map((item) => {
    const parts: string[] = [`- ${item.name}`]

    if (item.type) {
      parts.push(`(${item.type})`)
    }

    if (item.description) {
      parts.push(`- ${item.description}`)
    }

    if (item.registry) {
      parts.push(`[${item.registry}]`)
    }

    parts.push(
      `\n  Add command: \`${npxShadcn(`add ${item.addCommandArgument}`)}\``
    )

    return parts.join(" ")
  })

  let header = `Found ${results.pagination.total} items`
  if (query) {
    header += ` matching "${query}"`
  }
  if (registries && registries.length > 0) {
    header += ` in registries ${registries.join(", ")}`
  }
  header += ":"

  const showingRange = `Showing items ${
    results.pagination.offset + 1
  }-${Math.min(
    results.pagination.offset + results.pagination.limit,
    results.pagination.total
  )} of ${results.pagination.total}:`

  let output = `${header}\n\n${showingRange}\n\n${formattedItems.join("\n\n")}`

  if (results.pagination.hasMore) {
    output += `\n\nMore items available. Use offset: ${
      results.pagination.offset + results.pagination.limit
    } to see the next page.`
  }

  return output
}