ByteAsk Embedded Docs MCP server
Lets AI coding agents search embedded and firmware reference docs for verbatim, page-cited snippets on registers, protocols, and standards.
Also known as ByteAsk/ByteAsk-Embedded-MCP, byteask-embedded-mcp
- Stars
- 26
- Tools
- —
- Downloads, 30 days
- —
- Latest version
- 1.0.1
- Last commit
- Jun 20, 2026
- License
- MIT
What is ByteAsk Embedded Docs MCP?
ByteAsk Embedded Docs lets AI coding agents search embedded and firmware reference docs for verbatim, page-cited snippets on registers, protocols, and standards.
Summary generated from the project's README
About ByteAsk Embedded Docs MCP server
Providing verbatim, page-cited technical documentation to AI coding agents is what embedded-docs enables for firmware and driver developers. It allows agents like Claude Code, Cursor, or Codex to retrieve exact register offsets, protocol function codes, and standard thresholds without the risk of hallucination. Instead of generating plausible but incorrect values, the server returns direct snippets from reference manuals or returns a no match response when information is unavailable.
Developers can use this as a remote service via Streamable HTTP or run it locally using the stdio transport. The hosted endpoint provides access to a full licensed corpus, while the local version includes a sample backend for immediate testing without API keys. Users can also implement their own retrieval engine by plugging a custom backend into the provided interface. The system includes tools to search the corpus, expand specific hits into full source sections, and request new documents.
What you can do with it
- 1Verify register valuesAn AI agent can search for specific register offsets or bit definitions to ensure firmware code is accurate.
- 2Implement communication protocolsDevelopers can use the tool to find exact Modbus function codes or SCPI commands required for hardware interaction.
- 3Prevent AI hallucinationsThe server ensures that coding agents rely on cited evidence rather than inventing technical specifications.
Written from the project's README. Every use case is checked against a quote from it.
How to install ByteAsk Embedded Docs MCP
Formats verified 10 Nov 2026Install ByteAsk Embedded Docs MCP in Claude Code
$ claude mcp add --transport http byteask-embedded-mcp https://mcp.byteask.ai/mcpInstall ByteAsk Embedded Docs MCP in Cursor
~/.cursor/mcp.json
{
"mcpServers": {
"byteask-embedded-mcp": {
"url": "https://mcp.byteask.ai/mcp"
}
}
}Install ByteAsk Embedded Docs MCP in VS Code
.vscode/mcp.json
{
"servers": {
"byteask-embedded-mcp": {
"type": "http",
"url": "https://mcp.byteask.ai/mcp"
}
}
}Install ByteAsk Embedded Docs MCP in Codex
~/.codex/config.toml
[mcp_servers.byteask-embedded-mcp] url = "https://mcp.byteask.ai/mcp"
Install ByteAsk Embedded Docs MCP in Gemini CLI
~/.gemini/settings.json
{
"mcpServers": {
"byteask-embedded-mcp": {
"httpUrl": "https://mcp.byteask.ai/mcp"
}
}
}Configuration
BYTEASK_BACKENDMCP_TRANSPORT
| Name | Description | |
|---|---|---|
| BYTEASK_BACKEND | — | |
| MCP_TRANSPORT | — |
README
View on GitHubByteAsk Embedded MCP
Page-cited answers from embedded & firmware reference docs — for coding agents that can't afford to guess a register value.
Official MCP Registry Namespace: ai.byteask/embedded-docs · Remote MCP Endpoint: https://mcp.byteask.ai/mcp
Quickstart · Tools · Connect a client · Configuration · Hosted server · Contributing
ByteAsk Embedded MCP is the open-source server behind ByteAsk Embedded Docs: a source-grounded, page-cited evidence-retrieval MCP server for coding agents (Claude Code, Codex, Cursor) that write firmware / driver / protocol code and need exact facts — SunSpec points, register offsets, Modbus function codes, trip thresholds, SCPI commands, API symbols.
It returns verbatim snippets with page citations — never an authored answer — and when nothing is relevant enough it says no match rather than fabricate. Every document is treated equally: no authority layer, no filters.
[!NOTE] What's in this repo: the MCP server — tools, transports (stdio + Streamable HTTP), bearer auth, DNS-rebinding protection, result rendering — plus a small, pluggable retrieval interface.
What's not in this repo: the retrieval engine and the document corpus. How documents are parsed, chunked, embedded, and ranked, and the licensed source material itself, sit behind the
SearchBackendseam and power the hosted endpoint athttps://mcp.byteask.ai/mcp. This repo ships an in-memorySampleBackend(a few illustrative, public-knowledge records) so the server runs out of the box.
Why
- Cited, or nothing. Every hit is verbatim source text with a section + page citation. On a miss it returns an honest "no confident match" — it never invents a register value.
- Built for coding agents. The tool descriptions and triggers are tuned so agents
call
search_docsreflexively the moment they see a hex literal, a Modbus code, an IEEE clause, a SCPI verb, or an MCU part number — before answering from memory. - Two transports, one server.
stdiofor local agents, Streamable HTTP for hosted. - Bring your own retrieval. The search engine is a two-method interface — swap in
anything behind
BYTEASK_BACKENDwithout touching the server. - Zero-setup demo. The bundled
SampleBackendruns immediately. No API keys.
Quickstart
Requires Python ≥ 3.10 and uv.
uv sync
uv run byteask-embedded-mcp # run as an MCP server (stdio)
That's it — the bundled SampleBackend serves a couple of illustrative records, so
search_docs works immediately. Run the offline tests with uv run pytest.
Connect a client
Hosted (no install)
The hosted server speaks Streamable HTTP at https://mcp.byteask.ai/mcp and is
backed by the full licensed corpus.
Claude Code:
claude mcp add --transport http byteask-embedded-docs https://mcp.byteask.ai/mcp
{
"mcpServers": {
"byteask-embedded-docs": {
"command": "npx",
"args": ["-y", "mcp-remote", "https://mcp.byteask.ai/mcp"]
}
}
}
Local (this repo)
The project-scoped .mcp.json registers the stdio server for clients
that read it. Manually, for Claude Code:
claude mcp add byteask-embedded-docs -- uv run byteask-embedded-mcp
Tools
Input is natural language (or an exact identifier). Output is compact markdown.
| Tool | What it does |
|---|---|
search_docs(query, limit=8) |
Search the corpus; return ranked, page-cited evidence. Each hit has a document title, a section + page citation, the verbatim snippet, and a result_id. A "no confident match" response means not found — do not fabricate. |
get_context(result_id) |
Expand a hit to its full source section. |
request_document(request) |
Ask for a missing document to be added (logged server-side). |
Example output:
## Results for "what Modbus function code writes multiple registers"
### Sample — Modbus Application Protocol (illustrative) — §6.12, p.30
> Function code 16 (0x10), Write Multiple Registers, writes a block of contiguous
> holding registers (1 to 123 registers) in a remote device. ...
_ref: sample:modbus-fc16_
Plug in your own retrieval
The server depends only on a two-method interface
(backend.py):
class SearchBackend(Protocol):
def search(self, query, limit=8, effort=None) -> dict: ...
def get_context(self, result_id, effort=None) -> dict: ...
Implement it, expose a factory make_backend(config) -> SearchBackend, and point the
server at it:
BYTEASK_BACKEND="my_pkg.my_module:make_backend"
The exact return-value contracts are documented at the top of backend.py.
Configuration
All settings are environment variables (loaded from .env; see .env.example).
| Variable | Default | Notes |
|---|---|---|
BYTEASK_BACKEND |
— | module:callable returning a SearchBackend; empty → SampleBackend |
BYTEASK_LOGS |
logs |
where query / request JSONL logs are written |
MCP_TRANSPORT |
stdio |
stdio (local agents) or http |
MCP_HTTP_HOST / MCP_HTTP_PORT |
127.0.0.1 / 8000 |
HTTP bind address |
MCP_HTTP_AUTH_TOKEN |
— | bearer token for HTTP (empty = unauthenticated, dev only) |
MCP_ALLOWED_HOSTS |
— | comma-separated hosts allowed in the Host header (* disables) |
LOG_LEVEL |
INFO |
stderr log verbosity |
MCP_TRANSPORT=http MCP_HTTP_AUTH_TOKEN=$(openssl rand -hex 32) \
uv run byteask-embedded-mcp --host 0.0.0.0 --port 8000
Clients then send Authorization: Bearer <token>. The bundled bearer check is a
shared-secret stub — replace it with real auth (OAuth 2.1 resource server, mTLS,
or a trusted reverse proxy) before exposing publicly. DNS-rebinding protection stays
on independently via MCP_ALLOWED_HOSTS.
Hosted server
You don't need to run anything to use ByteAsk Embedded Docs. The hosted server gives Claude Code, Codex, Cursor, and any MCP client exact, page-cited facts from embedded and firmware reference docs — register maps, protocol function codes, SCPI commands, standard thresholds, datasheet specs. The guarantee: verbatim source, or "no match" — never an invented value.
| Name | byteask-embedded-docs |
| Endpoint | https://mcp.byteask.ai/mcp (Streamable HTTP) |
| Docs & per-client setup | https://docs.byteask.ai/embedded |
This repository is the open-source server that powers that endpoint.
Project layout
src/byteask_embedded_mcp/
server.py # FastMCP app + 3 tools (search_docs, get_context, request_document)
backend.py # SearchBackend protocol + in-memory SampleBackend (swap for real retrieval)
render.py # structured result -> compact markdown
http_auth.py # Streamable HTTP entrypoint + stub bearer-token guard
config.py # server config (transport, logging, backend selection)
schemas.py # Hit / Section result types
obs.py # per-call JSONL logging
tests/ # offline unit tests (renderer, backend, server tools)
assets/ # README demo GIF + its deterministic generator
Security
- stdout stays clean in stdio mode (it is the JSON-RPC channel); all logs go to
stderr /
logs/*.jsonl. - The HTTP bearer check is a stub — unauthenticated if no token is set, a shared secret at best. Harden it before exposing widely.
- DNS-rebinding protection is on by default for the HTTP transport.
Contributing
PRs and issues are welcome.
uv sync # install (incl. dev tools)
uv run pytest # run the offline test suite
A few conventions to keep the server clean:
- The backend seam is the extension point. Retrieval internals (parsing, chunking,
embeddings, ranking) are intentionally out of scope here — build them behind
SearchBackendin your own package, not in this repo. - Keep the dependency surface small and the stdio path free of the HTTP stack.
- Add a test for new behavior; the suite is fully offline (no network, no keys).
License
MIT © ByteAsk
ByteAsk Embedded Docs MCP questions
How do I add ByteAsk Embedded Docs MCP to Claude Code?
Run claude mcp add --transport http byteask-embedded-mcp https://mcp.byteask.ai/mcp in your terminal. Add --scope user to make it available in every project.
How do I add ByteAsk Embedded Docs MCP to Cursor?
Open ~/.cursor/mcp.json and add the server under mcpServers, using the Cursor config shown in the install section above.
What does the ByteAsk Embedded Docs MCP server return?
It returns verbatim source snippets with section and page citations, or an honest no-match response instead of an invented answer.
Which tools does the server expose?
It exposes search_docs for ranked page-cited results, get_context to expand a hit to its full section, and request_document to ask for a missing document.
Can I run the server locally without API keys?
Yes, the bundled SampleBackend serves illustrative public-knowledge records so search_docs works immediately with no keys.
How do I plug in my own retrieval engine?
Implement the two-method SearchBackend interface, expose a make_backend factory, and set the BYTEASK_BACKEND environment variable.