orderly-mcp: Instructions file for Codex

AGENTS.md - Orderly MCP Server

Project Overview

This is a Model Context Protocol (MCP) server that provides Orderly Network documentation and SDK patterns to AI assistants. It enables developers to query documentation, get code examples, and receive guidance on building trading UIs.

Key Technologies:

• TypeScript (ES modules)
• MCP SDK for tool/resource definitions
• Vitest for testing
• Yarn for package management
• ESLint + Prettier for code quality

Architecture

Entry Points:

• src/index.ts - Stdio transport (for local MCP clients like Claude Desktop)
• src/http-server.ts - HTTP transport (for hosted deployments, Docker)
• src/server.ts - Shared MCP server logic (tools, resources, handlers)

Transports:

• Stdio: Default for local AI assistants, communicates via stdin/stdout
• HTTP: Stateless Streamable HTTP transport for remote access, runs on port 3000
• Docker: Runs HTTP mode by default with health checks

Tools (src/tools/*.ts):

• searchDocs.ts - Unified fuzzy search over documentation.json and type-accurate SDK symbols (sdk-symbols.json). A single search_orderly_docs tool surfaces doc chunks and inline hook/type/component/function records (signature, params, returns, props, source) from the js-sdk symbol bundle.
• contracts.ts - Contract address lookup
• workflows.ts - Workflow explanations
• apiInfo.ts - API documentation
• indexerApi.ts - Indexer API documentation
• componentGuides.ts - Component building guides
• orderlyOneApi.ts - Orderly One API documentation
• svApi.ts - Strategy Vault API documentation
• publicInfoApi.ts - Public Info API documentation

Data (src/data/*.json):

• Static JSON files with documentation, patterns, addresses
• Imported with with { type: "json" } syntax
• Read at runtime by tools

Resources (src/resources/index.ts):

• Handles URI-based resource requests
• Returns markdown or JSON content

Common Tasks

Build Project

yarn build