API reference

Serves one client over stdin and stdout; answers the exit status.

Answers the values that could complete one argument.

@App.Context.Context — toolchain, workspace, corpus, and index for handlers

The context for a toolchain, workspace, and corpus, with the index building in the background.

The reference index, waiting a bounded time while it is still being built.

Whether the reference-index wait has reached its deadline.

@App.Context.IndexState — progress of the background reference index

The features this server implements.

Answers server/discover: versions, capabilities, and instructions.

Answers initialize for a negotiated legacy version.

Answers a legacy ping.

The state before any input.

The next state and every reply line for one input line.

The handler of every stateless method, by method name.

@App.Dispatch.State — the session carried between input lines

Answers one prompt rendered with its arguments.

Answers one page of the prompts.

The table of contents of the documentation.

Answers one page of the documentation resources.

Answers the contents of one resource.

What every module-reference URI begins with.

Answers the module-reference template.

Answers the compiler's diagnostics for the code.

Answers the code as the formatter lays it out.

Answers the linter's findings for the code.

Answers a confined run's exit status and output.

Answers the report of the workspace's tests, or of those under one path.

The groups a document can belong to.

Answers one document, or one of its sections.

Answers the best-matching documentation sections for query.

Answers the quick fixes offered at a position.

Answers what could be written at a position.

Answers where the name at a position is declared, with its source.

Answers every declaration in the code.

Answers the type and documentation at a position.

Answers every use of the name at a position.

Answers the edits a rename would make, without applying them.

Answers the signature of the call around a position.

Answers declarations across the workspace whose names match the query.

Every public declaration of one module, rendered.

Answers every public declaration of the module the module argument names.

Answers declarations matching a name, description, or type shape.

Answers one tool call: its result text, or a tool error the model can act on.

Every tool's handler, by tool name.

Answers one page of the tool catalogue.

A complete tool result carrying one text block.

Answers the server's version, toolchain, library, workspace, index, and corpus.

Cache scope for results that depend on this machine.

Cache scope for results any client may share.

The server failed while answering.

The parameters are wrong, including a missing resource or cursor.

The JSON is not a valid request or notification.

Whether a version is one an initialize may select.

The jsonrpc member every message carries.

The version an initialize receives when it asks for one not supported.

Handshake-era versions an initialize may select, newest first.

Metadata key holding the capabilities a modern client declares per request.

The member of params and of a result that holds protocol metadata.

Metadata key naming the protocol version of one modern request.

Metadata key under which every result names this server.

The method does not exist in the era the request was admitted under.

The per-request protocol version this server serves statelessly.

The line is not JSON.

The resultType of every final result.

Every version this server accepts, modern first.

The requested protocol version is not one this server speaks.

Deadline for check, format, lint, and reference commands.

Search results answered when the caller names no limit.

Most characters of one document or reference answered at once.

Freshness hint for documentation reads.

Environment variable naming the pudu executable to use.

Environment variable naming the standard library directory to use.

Environment variable naming the workspace root.

Longest a request waits for the background reference index.

Guidance for a model, returned by discovery and initialize.

Freshness hint for tool, prompt, resource, and discovery lists.

Deadline for one language-server conversation.

The longest message line accepted, in bytes.

The longest deadline a caller may ask a run or test for.

The most search results a caller may ask for.

Most bytes kept from each stream of a child process.

Items per page of a list result.

Files per reference-indexing run.

Most bytes kept from one reference-indexing run, whose JSON covers every imported module.

Deadline for one chunk of reference indexing.

Reference-indexing runs at once.

Default deadline for pudu_run and pudu_test.

The name reported in serverInfo.

The display name reported in serverInfo.

This server's version; matches pudu.toml.

Freshness hint for standard-library reads.

@Domain.Catalog.Arguments.Args — validated arguments of one call

A validated integer argument.

A validated integer argument, or a fallback when it was not given.

A validated string argument.

Arguments checked against a tool's spec, or the first problem found.

Every prompt, in listing order.

Language rules and the verification workflow, appended to every prompt.

@Domain.Catalog.Prompts.PromptArgument — one named prompt input

@Domain.Catalog.Prompts.PromptSpec — one prompt described once

A prompt's description and user message, or why its arguments are refused.

A prompt as prompts/list describes it.

@Domain.Catalog.ToolSpec.Annotations — behaviour hints every tool declares

An integer argument bounded to minimum..maximum.

@Domain.Catalog.ToolSpec.Kind — JSON kind of one argument

The JSON Schema type name of an argument kind.

@Domain.Catalog.ToolSpec.Property — one declared tool argument

A string argument.

A tool as tools/list describes it.

@Domain.Catalog.ToolSpec.ToolSpec — one tool described once

Every tool, in listing order.

The tool with a name.

The path under a source root that a module's file must have.

Whether text is a dotted module name.

The name a module declaration gives, when the source begins with a valid one.

The module a source-root-relative file declares by its path, when the path is a module path.

Every section of every document, in corpus order.

The address of a heading: lowercase words joined by dashes.

@Domain.Docs.Chapter.Chapter — one published document by group

The document with a group and slug.

The documents of one group, in corpus order.

@Domain.Docs.Chapter.Section — a document cut at second-level headings

The section of a document matching a heading or anchor.

A document cut into sections at its second-level headings.

One line per document with its sections indented beneath it.

@Domain.Docs.Search.Hit — a ranked documentation section

How well one section answers a query; zero when no term matches.

The best-matching sections, highest score first.

The distinct search terms of a query, stop words removed.

@Domain.Lsp.Conversation.Answer — result and diagnostics from a transcript

The question's answer and the published diagnostics in a transcript.

Every framed message of one question, from handshake to exit.

One message with its Content-Length header.

The question's parameters, with the position made 0-based.

@Domain.Lsp.Conversation.Question — one question at 1-based position

Code action titles, one per line.

Completion items, one per line, at most limit.

Diagnostics, one per line with position, severity, and code.

A document's declarations, nested ones indented.

The hover contents as text.

@Domain.Lsp.Render.Location — a 1-based position in a shown path

A location as path:line:character.

Every location in a definition or references result.

The active signature, its active parameter, and its documentation.

The edits of a rename, one per line.

Matching declarations with where each is.

The era governing one request, or the refusal to answer it with.

@Domain.Protocol.Negotiation.Era — version governing one admitted request

Whether a method opens a legacy session.

The legacy version an initialize receives.

@Domain.Protocol.Negotiation.Session — the only process-scoped protocol state

The cursor parameter, when there is one.

One page of a list and the cursor of the next, if any remain.

The exported declarations in pudu doc --json output, each once.

The qualified names pudu api --json reports as public.

@Domain.Reference.Entry.Entry — one public declaration

@Domain.Reference.Entry.Found — a ranked declaration match

Every module named by the entries, sorted.

The entries of one module, in catalogue order.

One declaration with its signature and indented documentation.

Every declaration of one module; empty when the module is unknown.

The best-matching declarations, highest score first.

A request id as the JSON it arrived as.

@Domain.Rpc.Message.Incoming — one classified input line

One input line classified as a request, notification, response, or refusal.

@Domain.Rpc.Message.RequestId — string or integer request identity

@Domain.Rpc.Reply.Cache — caching hint for complete results

A complete result body: the given fields plus resultType, serverInfo, and any cache hint.

The reply line carrying an error; the id is null when it could not be read.

The reply line carrying a result.

The JSON-RPC error code for a refusal.

Structured error data, for the refusals that carry it.

The error message for a refusal, with its detail.

@Errors.RpcError.ProtocolError — every protocol-level refusal

One sentence saying what went wrong and what to do next.

@Errors.ToolError.ToolFailure — failures reported as tool results

@Generated.Docs.Corpus — published Pudu prose, generated; do not edit

The language server's answer to one question, or why there is none.

Whether a child has reached its execution deadline.

@Services.Process.Bounded.Finished — what a bounded child left behind

Runs program to its end or its deadline and answers everything it wrote, within the cap.

At most limit bytes as text, cut on a character boundary, and whether anything was cut.

The public declarations of every file, from the compiler's reference output.

The file of one module.

The public declarations of one module's file.

@Services.Reference.ModuleFile — one importable module and its file

Every module file of the standard library and the workspace's installed packages.

A finished run with a status and output, for scripted toolchains.

The standard library an installed or development compiler uses.

The toolchain this machine has, located from the environment.

A toolchain that answers from a function instead of a process.

@Services.Toolchain.Toolchain — compiler location, library, version, and runner

The workspace rooted at a directory, canonicalized when it exists.

The workspace named by PUDU_MCP_ROOT, else the current directory.

A path relative to the workspace root when it is inside it.

The real location of path inside the workspace, or why it is refused.

@Services.Workspace.Target — the file one command reads

Runs use on the file source or path names; scratch files are removed afterwards.

@Services.Workspace.Workspace — the directory path arguments stay inside

A boolean member, or None when absent or of another kind.

An integer member, or None when absent or of another kind.

The JSON Schema type name of a value.

A member of an object, or None.

An object's members in order; empty for any other value.

The integer at a path of member names, or None.

The string at a path of member names, or None.

A string member, or None when absent or of another kind.

A JSON array of strings.

Text of at most limit characters, with a line saying how much was cut.

Text with line breaks and tabs folded into single spaces.

width characters around the first match of needle, on one line.

The file:// URI of an absolute path.

The path a file:// URI names, or None for any other scheme.

The part of a URI after scheme, or None when it has another scheme.