Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

The agent example is undocumented

Chiusa
#422 3 commenti 0 reazioni 1 assegnatario Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

@GazzyLee ci sta già lavorando.

Dal 17/10/2026.

  • #452 di @sparkysolutions10-pixel — aperta
  • #486 di @GazzyLee — aperta

Valutazione

Questa issue non è ancora stata valutata.

Descrizione

area:docs difficulty:easy help wanted points:100 Stellar Wave
Background

package.json exposes two commands:

"mcp:server": "tsx examples/mcp-server/run.ts",
"mcp:agent": "tsx examples/mcp-server/agent.ts"

Neither is explained anywhere a reader would look. There is no README in
examples/mcp-server/, nothing in the repo README, and no description of what
the agent example does, what it needs, or what it will spend.

Someone who runs npm run mcp:server without reading the source will discover
its requirements through a startup failure, and its behaviour by watching it.
For a tool that signs with a mainnet key, that is the wrong order.

What to build
  • A README in examples/mcp-server/ covering what each command does, what
    configuration it needs, which network it talks to, and what it can spend.
  • A worked example of connecting a client and calling each tool.
  • A prominent warning about the mainnet key, with the safe way to try it first.
  • A link from the repo README, next to the REST and GraphQL documentation.
  • Every example runnable exactly as written.
Acceptance criteria
  • examples/mcp-server/README.md exists and is linked from the repo README
  • Both npm commands are documented with their configuration
  • The spending risk is stated prominently
  • A client connection example is included and works as written
  • No key, address or contract id in any example is shortened

Drips Wave · Complexity: Easy · 100 points


Repo: Divinity-Labs/Lens. The MCP server is src/mcp/server.ts
(BazaarMcpServer) with error codes in src/mcp/codes.ts. It is started by
npm run mcp:server → examples/mcp-server/run.ts, and there is an agent
example at examples/mcp-server/agent.ts. Tests are tests/mcp.test.ts.

Run the tests: npm test. The tests are vitest, not jest. A single file
is npx vitest run tests/mcp.test.ts.

Load test (prices) is already failing on main. Not your PR.

This surface signs with a real mainnet key. examples/mcp-server/run.ts
requires MCP_AGENT_SECRET_KEY_MAINNET and builds a signer for
stellar:pubnet. Anything you change here can move real money, so prefer
failing closed, and never log, echo or test with a real secret key.

Never elide an address, a contract id or a key in code, comments or
fixtures. A previous batch shortened a contract id and five contributors
invented plausible-looking ids to fill the gap. Write it in full or not at all.

An agent is the least able caller to notice a wrong answer. It will reason
over whatever it is handed, confidently. Prefer a structured error over a
best-effort result.


Required: Before submitting, join the contributor Telegram so your work can be tracked and counted toward the Stellar Wave: https://t.me/+fxHXq8f1SwlkZDBk

Lingua principale
TypeScript
Stelle
4
Fork
71
Merge medio
1g 6h
PR unite (30g)
58

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di Divinity-Labs/Lens

Tutte le issue di Divinity-Labs/Lens

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.