mirror of
https://github.com/mcp-use/mcp-use.git
synced 2026-09-14 18:06:01 +08:00
82772dcbab
* fix(cli): isolate dev test cleanup failures (#2337) * chore: enter canary prerelease mode * fix(client): project OAuth tokens before ready (#2358) * docs(python): fix misleading CI badges (#1871) (#1872) * fix(client): project OAuth tokens before ready --------- Co-authored-by: AxelRay <raynaldo.axel@gmail.com> * chore(typescript): version packages (canary) * feat(inspector): show RPC latency in the timing column (#2349) * feat(inspector): prioritize RPC latency in traffic rows * fix(inspector): preserve timestamp semantics * chore(typescript): version packages (canary) * docs(cli): add a README so the npm page is not blank (#2350) * docs(cli): add a README so the npm page is not blank @mcp-use/cli is the only published package in the family without a README, and the registry shows it: $ curl -s https://registry.npmjs.org/@mcp-use%2Fcli | jq -r .readme "" So npmjs.com/package/@mcp-use/cli renders nothing for the package that provides the `mcp-use` executable. The README is deliberately short, because the package is rarely installed directly: `mcp-use` depends on it and exposes the same bin, which the existing CLI reference page states and package.json confirms. It covers what the package is, how it actually reaches users, the command list from `mcp-use --help`, and links to the v2 CLI reference and quickstart. Both links resolve with no redirect. README.md is not in this package's `files` array, but npm always includes it. Confirmed rather than assumed: $ npm pack --dry-run npm notice Tarball Contents npm notice 1.5kB README.md * docs(cli): apply review, lead with the client Review feedback on #2350: mention the built-in MCP client, drop the paragraph about not installing the package directly, and show `mcp-use client` in the example. The example commands are the ones I ran against a local server while checking the command list: `client connect <name> <url>` then `client <name> tools list`. * docs(client): put the sandbox subpath inside the coverage gate (#2353) `@mcp-use/client` publishes three subpaths and typedoc only inspected two of them. `./sandbox` was missing from entryPoints, so everything exported from `src/sandbox.ts` sits outside the gate #2312 turned on. Not theoretical. Appending an undocumented export to that file and running `pnpm docs:api`: without src/sandbox.ts in entryPoints exit 0, no warnings with it exit 3 sandbox.SandboxProbe (TypeAlias) does not have any documentation sandbox.SandboxProbe.probe (Property) does not have any documentation Nothing is undocumented there today. The single export, buildSandboxProxyBlobHtml, has TSDoc and is also re-exported through ./react, which is why the hole has not shown up yet. This closes it before it does. * test(cli): let Windows use native file watching (#2338) * test(cli): let Windows use native file watching Experiment requested in #2273. The dev server currently forces chokidar into 100ms polling on Windows: ...(process.platform === "win32" && { usePolling: true, interval: 100 }) The comment justifies it with Windows notifications being coalesced or dropped during a transform, and nobody has been able to find an upstream Vite, Chokidar or Node report for that specific claim. Polling also makes the initial scan much slower, which is the suspected cause of the Windows-only `dev.test.ts` timeouts: if the test writes a file before the scan finishes, the new contents become the polling baseline and no change event is ever emitted. That failure mode cannot be fixed by raising a timeout, and it matches the observed signature, a `waitFor` timeout with no `last error` because the probe never threw. This removes the override so the Windows CI job runs with native watching. The point is the CI result, not the diff. Local run is unaffected, since the override never applied off Windows: dev.test.ts 34 passed, 34 total. * test(cli): avoid equal-length watcher update --------- Co-authored-by: Andrew Khadder <andrew.khadder@gmail.com> * chore(typescript): version packages (canary) * fix(dev): consolidate server request logs (#2351) * fix(dev): consolidate server request logs * refactor(server): simplify request log formatting * fix(server): omit clients from HTTP logs * fix(server): remove request log timestamps * fix(server): address request logging regressions * chore(typescript): version packages (canary) * docs(changelog): update changelogs for v20.3.3 and v12.0.6 releases - Added details for v20.3.3, including enhancements to RPC latency display and log prefixing for colocated Inspector logs. - Updated mcp-use to v2.3.4. - Added details for v12.0.6, highlighting CLI version heading enhancements and documentation fixes. - Updated mcp-use to v1.34.6. --------- Co-authored-by: Elioooon <102770919+Elioooon@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: AxelRay <raynaldo.axel@gmail.com> Co-authored-by: Ayaan Gazali <ayaangazali.work@gmail.com> Co-authored-by: Andrew Khadder <andrew.khadder@gmail.com> Co-authored-by: Andrew Khadder <54488379+khandrew1@users.noreply.github.com>
Mintlify Starter Kit
Click on Use this template to copy the Mintlify starter kit. The starter kit contains examples including
- Guide pages
- Navigation
- Customizations
- API Reference pages
- Use of popular components
Development
Install the Mintlify CLI to preview the documentation changes locally. To install, use the following command
npm i -g mintlify
Run the following command at the root of your documentation (where docs.json is)
mintlify dev
Publishing Changes
Install our Github App to auto propagate changes from your repo to your deployment. Changes will be deployed to production automatically after pushing to the default branch. Find the link to install on your dashboard.
Troubleshooting
- Mintlify dev isn't running - Run
mintlify installit'll re-install dependencies. - Page loads as a 404 - Make sure you are running in a folder with
docs.json