Skip to content

Make Developers a clean CLI and API reference - #2000

Merged
asim merged 1 commit into
mainfrom
docs/developers-reference
Oct 2, 2026
Merged

asim merged 1 commit into
mainfrom
docs/developers-reference

Conversation

@asim

@asim asim commented Oct 2, 2026

Copy link
Copy Markdown
Member

Developers had become an agent-creation walkthrough. Restore the curl installer and focus the page on the useful entry points: asking Micro, assigning work, reading results and using services. Put Tools/MCP, API, x402 and token links at the top; keep self-hosting as a short link to its guide.

Checked examples against the installer and CLI dispatch/HTTP handlers. Server and CLI tests pass. Uses existing shared document and table styling; fresh desktop/mobile screenshots were unavailable.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 2, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-02T09:06:20.749002Z ff0196a PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@asim
asim merged commit a069109 into main Oct 2, 2026
1 check passed

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: ff0196aada

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment on lines +32 to +36
<pre>curl '` + base + `/work' \
-H "Authorization: Bearer $MU_TOKEN" \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{"agent":"researcher","prompt":"Compare SQLite and PostgreSQL for a small personal server"}'
-H 'Content-Type: application/json' \
-d '{"prompt":"Research the options and recommend one"}'

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Warn against replaying ambiguous work submissions

If POST /work completes server-side but the client loses the response, repeating this curl creates another durable task because the product endpoint has no idempotency key; both jobs may consume credits and repeat tool side effects. This rewrite removes the previous inspect-before-retry warning while continuing to advertise the raw POST, so restore that warning adjacent to the example or document an idempotency mechanism.

Useful? React with 👍 / 👎.

Comment on lines +15 to +16
<h2>CLI</h2><p>Install Mu and connect to your account:</p><pre>curl -fsSL https://raw.githubusercontent.com/micro/mu/main/install.sh | sh
mu login ` + base + `

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Make the post-install command reachable in the current shell

On a fresh machine where ~/.local/bin is not already in PATH, the piped installer puts mu there and exports the updated path only inside its child shell, so the immediately following mu login fails with command not found. Invoke the installed binary by its full path or tell the user to reload/source their shell before continuing.

Useful? React with 👍 / 👎.

<table class="data-table stacked"><thead><tr><th>Resource</th><th>Use</th></tr></thead><tbody>
<tr><td><code>POST /agent</code></td><td>Ask Micro with a prompt and optional thread.</td></tr>
<tr><td><code>POST /agent/NAME</code></td><td>Ask a specific agent.</td></tr>
<tr><td><code>GET /agents</code></td><td>List your agents.</td></tr>

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Document content negotiation for every listed read

A bearer-authenticated client following a table-only entry such as GET /agents without Accept: application/json receives the HTML resource because these handlers select JSON through content negotiation. The curl examples do not cover /agents or /inbox, and this change removes the previous global header requirement, so restore an explicit Accept: application/json instruction beside the table.

AGENTS.md reference: AGENTS.md:L16-L18

Useful? React with 👍 / 👎.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant