-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcontext7.json
More file actions
30 lines (30 loc) · 3.29 KB
/
Copy pathcontext7.json
File metadata and controls
30 lines (30 loc) · 3.29 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
{
"$schema": "https://context7.com/schema/context7.json",
"projectTitle": "@imqueue/mcp",
"description": "Model Context Protocol server for @imqueue — lets AI coding agents search the docs and scaffold typed services & clients from the editor.",
"excludeFolders": ["src", "lib", "dist", "node_modules", "test", "tests", "coverage"],
"excludeFiles": ["CHANGELOG.md", "LICENSE"],
"rules": [
"Run the server over stdio with `npx -y @imqueue/mcp`; add it to your AI tool's MCP config (mcpServers, or servers + type:stdio for VS Code / Visual Studio).",
"search_docs, get_doc, list_packages, scaffold_service and scaffold_client are read-only: the scaffold_* tools return generated source text and write no files, so an agent has no reason to hesitate over them.",
"The CLI-bridge tools — create_service, generate_client, cli_install, fleet, config, logs — change state on the machine the server runs on.",
"create_service is dry-run by default — pass apply:true to actually write files.",
"The hosted server at https://mcp.imqueue.org/mcp offers six read-only tools: search_docs, get_doc, list_packages, scaffold_service, scaffold_client and local_install_guide.",
"The CLI-bridge tools act on the caller's own machine, so they exist only in the local (stdio) install and are not registered on the hosted server at all.",
"All five shared tools declare an outputSchema and return structuredContent as well as text. Consume the structure rather than parsing the markdown.",
"search_docs gives results[] carrying a url for get_doc; list_packages gives packages[] with install commands.",
"scaffold_service gives files[] with paths and content, plus types[] naming the classes that need @classType(); scaffold_client gives the namespace the generated module exports.",
"get_doc's outputSchema is metadata only — url, mimeType, bytes, truncated — because the page body travels once, in content. It is not absent; it just never repeats the payload.",
"The CLI-bridge tools return unstructured `imq` output and have no outputSchema.",
"Never hand-write an @imqueue client. `imq client generate <ServiceClassName> <dir>` writes <dir>/<ServiceClassName>.ts.",
"A generated client's only export is a namespace named after the service with a lowercase first letter, holding a class whose trailing `Service` is replaced by `Client`.",
"So a UserService gives `import { userService } from './clients/UserService.js'` and `new userService.UserClient()`.",
"The name passed to the CLI is the service's class name, because that is also its queue name. Call scaffold_client for the exact command and import line for a given service.",
"Every remotely callable method needs @expose() and a complete typed JSDoc block: JSDoc is the only type source that survives to runtime, so an undocumented parameter is published as `any`.",
"A class that crosses the RPC boundary needs @classType() on the class and @property() on every field, or the generated client types those fields `any`. Both omissions compile cleanly.",
"Consuming projects must build with `removeComments: false`, or the JSDoc the runtime depends on is stripped.",
"See the install matrix and tool reference at imqueue.org/mcp/."
],
"url": "https://context7.com/imqueue/mcp",
"public_key": "pk_fjNtG1ue4XLAYwKYgyOMq"
}