Pi Verse Docs

On-demand Verse / UEFN docs lookup for Pi via verse-mcp, without a resident MCP daemon.

What this is

pi-verse-docs gives Pi agents short-lived Verse docs tools.

• No .mcp.json always-on MCP server
• Spawns verse-mcp only per tool call
• Covers Verse language docs and UEFN API digest lookup

Prerequisites

One of these setups is required:

1. Recommended: uvx

   uvx --from git+https://github.com/BurgersJackson/verse-mcp verse-mcp
   

2. Alternative: Python 3.10+ plus pip-installed verse-mcp

   pip install git+https://github.com/BurgersJackson/verse-mcp.git
   

If Python is missing, install it from https://www.python.org/downloads/

Install

From npm:

pi install npm:pi-verse-docs

From GitHub:

pi install git:github.com/eiei114/pi-verse-docs

Local development:

git clone https://github.com/eiei114/pi-verse-docs.git
cd pi-verse-docs
npm install
pi -e .

Tools

Tool	Purpose
verse_docs_status	Check Python / verse-mcp / cache readiness, optional MCP ping
verse_docs_search	Search Verse language docs
verse_docs_search_api	Search Verse / UEFN API digest
verse_docs_list_chapters	List Verse language book chapters
verse_docs_get_chapter	Read a full Verse book chapter
verse_docs_list_api_modules	List Verse / UEFN API digest modules
verse_docs_get_api_module	Read a full API digest section
verse_docs_cache_all	Warm the Verse docs cache

Commands

Command	Purpose
/verse-docs:status	Show install / readiness summary
/verse-docs:search	Prompt for a Verse language docs query
/verse-docs:search-api	Prompt for a Verse / UEFN API query
/verse-docs:list-chapters	List Verse language book chapters
/verse-docs:list-api-modules	List Verse / UEFN API digest modules
/verse-docs:cache	Pre-download Verse chapters for faster searches

Recommended workflow

When working with Verse or UEFN:

1. Run verse_docs_status if environment setup is uncertain.
2. Run verse_docs_cache_all once per machine/session if repeated lookups are likely.
3. Use verse_docs_search_api before writing non-trivial UEFN API code.
4. Use verse_docs_search for language semantics like failure, decides, concurrency, effects, or modules.
5. Use verse_docs_list_chapters / verse_docs_list_api_modules when you need valid names before a full read.
6. Use verse_docs_get_chapter / verse_docs_get_api_module for deeper reading after search.

Configuration

• VERSE_MCP_CACHE_DIR — override the local cache directory used by upstream verse-mcp
• VERSE_DIGEST_PATH — override the bundled Verse API digest used by upstream verse-mcp

Example:

VERSE_MCP_CACHE_DIR=/tmp/verse-cache pi

Notes

• Search / get tool output is truncated for safety.
• First search can be slower before cache warm-up.
• pi-verse-docs is for reference lookup, not compile diagnostics or UEFN editor automation.
• For compile / LSP diagnostics, use a Verse diagnostics MCP separately.

Development

npm install
npm run ci

Release

This package is configured for npm Trusted Publishing. No NPM_TOKEN is stored in the repo.

Manual publish with npm 2FA / OTP is also supported from a logged-in maintainer machine.

npm run ci
npm publish --access public

If npm challenges for 2FA, the CLI will prompt for an OTP, or you can pass --otp=<code>.

See docs/release.md.

Security

Pi packages execute code with your local permissions. Review extensions before installing third-party packages.

For vulnerability reporting, see SECURITY.md.

Links

• npm: https://www.npmjs.com/package/pi-verse-docs
• GitHub: https://github.com/eiei114/pi-verse-docs
• Upstream MCP: https://github.com/BurgersJackson/verse-mcp

License

MIT