Files
cursor-byok/apps/docs/content/docs/faq.en.mdx
T
leokun e874d68b79 docs: update README and documentation to clarify model configuration and restart requirements
- Enhanced instructions for restarting Cursor after upgrades or initial model configuration to ensure proper functionality.
- Updated references from "Troubleshooting" to "Frequently Asked Questions" for better alignment with user needs.
- Improved clarity in the installation and usage steps across multiple language versions.
2026-08-28 16:12:06 +08:00

91 lines
6.0 KiB
Plaintext

---
title: Frequently Asked Questions
description: Answers to common Cursor Byok questions about setup, accounts, models, and TAB completion.
icon: Wrench
---
## Q: Why does Cursor show “not signed in,” omit the model, or show `An unexpected error occurred` after an upgrade or first setup?
**A:** After upgrading Cursor or configuring a model for the first time, Cursor needs to establish a new connection. If you see the following error, run the complete restart sequence instead of continuing in the current conversation:
```text
An unexpected error occurred. Request ID: 3871795e-2a93-4628-8308-c641047e9e43
```
Complete these steps in order:
1. Keep Cursor Byok running.
2. Quit Cursor completely, confirm the process has stopped, and restart it.
3. Start a new conversation instead of continuing one opened before setup or the switch.
4. Select your configured model from the model list.
The same sequence is required after a first-time Cursor upgrade or model setup. Conversations created with the current version stay synchronized with official Cursor conversations and can continue with official models.
## Q: Do I need to sign in to my own Cursor account when switching to the current version?
**A:** No. You can use your own models without a Cursor account. Signing in to any Cursor account is recommended because it provides better access to official plugins, MCP, Skills, codebase indexing, and official models. Switching Cursor accounts does not require quitting Cursor Byok.
## Q: Can I continue a conversation that was opened with the old version?
**A:** Conversations created by the old assistant cannot be continued directly in the current version; start a new conversation. Conversations created with the current version synchronize with Cursor and can switch between your models and official models.
## Q: Does the current version support official Cursor models?
**A:** Yes. Official Cursor models and your configured local models can coexist. Auto, Composer, and other official models continue to use Cursor's official service, while your configured models are routed through Cursor Byok.
## Q: Why does selecting Auto show a quota or account error?
**A:** Auto uses only official Cursor models and does not automatically use your configured models. If your account has no official quota, select your own model manually from the model list. With official quota, you can switch freely between official and configured models.
## Q: Can I still use Cursor plugins, MCP, Skills, and codebase indexing?
**A:** Yes. The current version coexists with Cursor's official service. After signing in to any Cursor account, you can continue using official plugins, MCP, Skills, Auto, and codebase indexing. Codebase indexing uses Cursor's official indexing service, so upgrade Cursor to the latest version.
## Q: Why is the first semantic search slow?
**A:** The first semantic search call automatically downloads the embedding model. Later searches use the local model. Keep the network connection available and wait for the initial download to finish.
## Q: Where do I configure TAB completion?
**A:** Go to **System Settings → TAB Settings** in Cursor Byok and choose one of these modes:
- **Direct connection**: connects to the official TAB service for the account signed in to Cursor.
- **Community service**: uses the free TAB service provided by the author.
- **Custom**: connects to a TAB completion service that you deploy separately.
These TAB completion capabilities all come from Cursor's official service. Custom BYOK models are generally not suitable for code completion and are not used for TAB completion. After changing this setting, restart Cursor and start a new conversation.
## Q: Why do Agent requests fail even though the model test passes?
**A:** The model test verifies basic connectivity only. Agent requests also include longer context, tool definitions, and streaming responses. Check:
- Whether the upstream model supports tool calling.
- Whether the context window and maximum output tokens fit the model's limits.
- Whether the model type, request protocol, and server address match.
- Whether custom headers and extra parameters follow the upstream protocol.
- The upstream status code and response body in **Call Statistics** or call details.
## Q: What is the local CA, and what should I do if initialization fails?
**A:** The local CA (certificate authority) allows Cursor Byok to inspect HTTPS requests from Cursor. Its files stay on your machine. Go to **Cursor Settings** and click **Initialize CA**. When the system asks for authorization, follow the app's terminal instructions to install and trust it, then return to the app and click **I have initialized, refresh**.
If the status does not update, quit and restart Cursor Byok completely, then open Cursor Settings again.
## Q: What should I do if the model connectivity test fails?
**A:** Check the error category:
- **Authentication error**: confirm the API key is valid and the account can access the target model.
- **Endpoint not found**: confirm the model type, request protocol, and server address match.
- **Model not found**: use **Fetch Models** to check the model identifiers returned by the upstream.
- **Invalid parameters**: temporarily remove custom headers and extra parameters, then test again.
- **Connection timeout**: check your network, system proxy, and upstream service status.
## Q: What should I do about a fake account generated by the old version?
**A:** Sign out of the fake account in Cursor, then sign in to any Cursor account, or remain signed out while using your own models. The current version does not require a fake account or a “stop service” workflow to switch between official and configured models.
## Q: What information should I include when reporting another issue?
**A:** Open a report on [GitHub Issues](https://github.com/leookun/cursor-byok/issues) with your operating system, Cursor Byok version, model type, request protocol, redacted server address, error message, and reproduction steps. Never share API keys or other credentials.