cc44fa2169
Follow-up to #11440 for the latest comment on #11331. Problem: the ranker scored a tool as one bag of words. A query term in the tool's name counted like a mention in its description, and the server's instructions were copied into every tool's text, which lengthened it and lowered its score. Models often add words to a tool name, so `peekaboo app` ranked `mcp__peekaboo__app` 14th: other peekaboo tools mention "app" in shorter descriptions, and its own description says "applications". Fix: `Bm25Ranker` scores three fields separately: - name: a query term in the name counts 3x its IDF; the description part of BM25 is at most 2.2x, so a name match beats any number of description mentions; - description and schema text: BM25 as before, length-normalized on this field only; - namespace name, description, and instructions: 0.5x IDF per matching term, without length normalization. A tool whose whole local name (last `__` segment) is in the query gets a bonus worth one more match of every query term, so it mostly wins (`peekaboo app`, `describe app`, `read thread_read state`). A query that is exactly a tool's name still ranks it first (#11440). Applies to `tool_search` and codemode `searchTools()`. Not included: the comment's second point (loading a deferred tool on a direct call instead of `Tool X not found`). That error comes from `prepareToolCall` in `packages/agent`, which has no hook for unknown tools; it needs an agent-loop API change. |
||
|---|---|---|
| .. | ||
| docs | ||
| examples | ||
| install-lock | ||
| schemas | ||
| scripts | ||
| src | ||
| test | ||
| .gitignore | ||
| CHANGELOG.md | ||
| package.json | ||
| README.md | ||
| tsconfig.build.json | ||
| tsconfig.examples.json | ||
| vitest.config.ts | ||
New issues and PRs from new contributors are closed automatically. Maintainers review closed submissions daily. See CONTRIBUTING.md.
Pi
Pi is a minimal, extensible agent harness that you can make your own.
Adapt Pi to your workflows, not the other way around. Customize Pi with extensions, skills, prompt templates, and themes. Bundle them as Pi packages and share via npm or git.
Pi ships with powerful defaults but skips features like sub-agents and plan mode. Ask Pi to build what you want, or install a package that does it your way.
Use Pi interactively, automate it in print or JSON mode, control it over RPC, or build apps with the Pi TypeScript SDK. See OpenClaw for a real-world integration.
Getting started
Install the command-line interface:
curl -fsSL https://pi.dev/install.sh | sh
On Windows:
powershell -c "irm https://pi.dev/install.ps1 | iex"
The installer pins all dependencies and updates Pi with pi update. Alternatively, install directly with npm, which does not pin transitive dependencies:
npm install -g --ignore-scripts @earendil-works/pi-coding-agent
Pi requires Node.js 22.19 or newer. The macOS, Linux, and Windows installers can install it if needed. Pi does not require dependency lifecycle scripts for a normal npm installation.
On macOS and Linux, Nix users can install the latest release with nix profile add github:earendil-works/pi/stable. See the quickstart for updating and pinning releases.
Start Pi in the directory where you want it to work:
cd /path/to/project
pi
For a built-in AI provider, run /login inside Pi to connect a subscription or API key. Then give Pi a task.
See the documentation for full setup and usage instructions.
Share your OSS coding agent sessions
If you use Pi for open source work, please share your coding agent sessions.
Public OSS session data helps improve models, prompts, tools, and evaluations using real development workflows.
For the full explanation, see this post on X.
To publish sessions, use badlogic/pi-share-hf using a Hugging Face account and the Hugging Face CLI.
- Demo video on how to publish Pi sessions
- Published Pi development sessions:
badlogicgames/pi-monoon Hugging Face.
Development
Clone the repository, install its dependencies, and run Pi from source:
git clone https://github.com/earendil-works/pi
cd pi
npm install --ignore-scripts
./pi-test.sh
pi-test.sh can be called from any directory and preserves the caller's working directory.
Before submitting changes, run:
npm run check
./test.sh
Read CONTRIBUTING.md before opening an issue or pull request. It defines the contribution gate, issue quality bar, and required checks. Read AGENTS.md for repository-specific implementation, testing, dependency, and release rules.
License
MIT