Neurolink Guide

What it does

When your agent uses it

• S ask how to use neurolink
• Integrate AI providers
• Work with multimodal content

Example prompts

• “/neurolink-guide”

Requirements

• Node.js
• A credential in OPENAI_API_KEY
• A credential in ANTHROPIC_API_KEY
• Pre-approved tools (allowed-tools): Read, Grep, Glob

Workflow steps

4 steps, taken from the first numbered list in SKILL.md.

1. 1Check the relevant reference file above
2. 2Review troubleshooting.md for common issues
3. 3Look at code templates in templates/
4. 4Read the full CLAUDE.md in the project root for architecture details

What it can do on your machine

Read from SKILL.md and the folder at commit 7302ab2. It shows what the files ask for, not the result of running them.

• Tool permissions

  Pre-approves these tools, so the agent can use them without asking each time:

  • Read
  • Grep
  • Glob

  From allowed-tools in the SKILL.md frontmatter.

• Runs code

  Ships script files (TypeScript), which the agent can run.

  Shell commands in SKILL.md call:

  • npm
  • pnpm
  • yarn

  From the folder's file list and the shell code blocks in SKILL.md.

• Network

  No URLs in SKILL.md. Its commands use npm, pnpm and yarn, which can reach the network depending on how they are called.

  From URLs in SKILL.md, links to its own repository left out.

• Credentials

  Names these keys or tokens, usually read from environment variables:

  • OPENAI_API_KEY
  • ANTHROPIC_API_KEY
  • GOOGLE_API_KEY
  • GOOGLE_APPLICATION_CREDENTIALS
  • AWS_ACCESS_KEY_ID
  • AWS_SECRET_ACCESS_KEY

  From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Neurolink Guide loads about 1.4k tokens when it runs. Until then it costs about 70 tokens; SKILL.md has 336 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it

~70

When it runs · the whole SKILL.md, loaded when a task matches

~1.4k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from juspay/neurolink at commit 7302ab2, republished under its MIT licence (© juspay). 336 words, ~1,385 tokens.

name

neurolink-guide

description

Guide for using the NeuroLink SDK and CLI. Invoke when users ask how to use neurolink, integrate AI providers, add MCP tools, configure RAG, set up memory, deploy servers, or work with multimodal content. Covers SDK, CLI, providers, tools, and enterprise features.

allowed-tools

Read, Grep, Glob

argument-hint

topic

npm install @juspay/neurolink
# or
pnpm add @juspay/neurolink
# or
yarn add @juspay/neurolink

import { NeuroLink } from "@juspay/neurolink";

const neurolink = new NeuroLink();

// Generate text
const result = await neurolink.generate("Explain quantum computing");
console.log(result.content);

// Stream response
const stream = await neurolink.stream({ input: { text: "Write a story" } });
for await (const chunk of stream.stream) {
  if ("content" in chunk) {
    process.stdout.write(chunk.content);
  }
}

# Generate content
neurolink generate "Your prompt"

# Stream output
neurolink stream "Write a story"

# Interactive mode
neurolink loop

# Start HTTP server
neurolink serve --port 3000

# Setup providers
neurolink setup openai

# OpenAI
OPENAI_API_KEY=sk-...

# Anthropic
ANTHROPIC_API_KEY=sk-ant-...

# Google AI Studio
GOOGLE_API_KEY=...

# Vertex AI
VERTEX_PROJECT_ID=...
GOOGLE_APPLICATION_CREDENTIALS=/path/to/credentials.json

# AWS Bedrock
AWS_ACCESS_KEY_ID=...
AWS_SECRET_ACCESS_KEY=...
AWS_REGION=us-east-1

import type {
  GenerateOptions,
  GenerateResult,
  StreamOptions,
  StreamResult,
  ChatMessage,
  ToolInfo,
  MCPServerInfo,
  RAGConfig,
  ProviderStatus,
} from "@juspay/neurolink";

© juspay, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 14 other files in docs/skills/neurolink-guide of juspay/neurolink.

• SKILL.md
• advanced-features.md
• cli-reference.md
• memory-conversations.md
• multimodal.md
• providers.md
• rag-integration.md
• sdk-quickstart.md
• templates/basic-setup.ts
• templates/rag-pipeline.ts
• templates/server-deploy.ts
• templates/streaming.ts
• templates/with-tools.ts
• tools-mcp.md
• troubleshooting.md

Open the folder on GitHubat commit 7302ab2