Skip to content

Latest commit

 

History

History
81 lines (57 loc) · 1.88 KB

File metadata and controls

81 lines (57 loc) · 1.88 KB
title AI-first usage
description Configure llms.txt context and the local MCP documentation server for coding agents.

AI-first usage

End users do not need AI files to use the hook.

These files exist for coding agents, docs-aware IDEs, and MCP clients that can consume project context before writing code.

Hosted context

Add these URLs to tools that support URL context:

https://crup.github.io/react-timer-hook/llms.txt
https://crup.github.io/react-timer-hook/llms-full.txt

Use llms.txt for short context. Use llms-full.txt when the tool can ingest API and recipe notes.

Local JSON context

pnpm install
pnpm ai:context

MCP server

Run the published docs MCP server:

npx -y @crup/react-timer-hook@latest

MCP client config:

{
  "mcpServers": {
    "react-timer-hook-docs": {
      "command": "npx",
      "args": ["-y", "@crup/react-timer-hook@latest"]
    }
  }
}

If the package is already installed locally, you can also run:

./node_modules/.bin/react-timer-hook-mcp

The bin shim points at the same bundled file: node_modules/@crup/react-timer-hook/dist/mcp/server.js.

It exposes:

react-timer-hook://package
react-timer-hook://api
react-timer-hook://recipes

It also exposes callable tools for MCP clients that prefer tool calls over resource reads:

Tool Title Description
get_api_docs Get API docs Returns compact API notes for @crup/react-timer-hook.
get_recipe Get recipe Returns guidance for a named recipe or use case.
search_docs Search docs Searches API and recipe notes for a query.

Verify locally:

printf '{"jsonrpc":"2.0","id":1,"method":"resources/list"}\n' | pnpm mcp:docs

The MCP server is bundled and minified into the npm package. It only exposes documentation resources; the React runtime remains separate from the MCP helper.