QUICKSTART

4ステップで接続

Quickstart

ゼロから最初の成功リクエストまで5分未満。以下では、素の curl、Claude のツール利用、OpenAI の function calling、そしてエラー処理のパターンを示します。

OpenAPI 記述を取得する

1回の GET で、各エンドポイントの機械可読な記述が返ります。どの LLM もそこから自己記述し、正しい呼び出しを組み立てられます。

# 拉取完整 OpenAPI 3.1 描述
curl -s https://api.fstar.io/openapi.json | jq '.info.version'
# => "1.0.0"

# 或直接读 LLM 友好的精简地图
curl -s https://api.fstar.io/llms.txt

エージェントフレームワークに渡す

openapi.json を Claude のツール定義や OpenAI の関数定義に変換します。ほとんどのフレームワークは OpenAPI から直接ツールスキーマを導出できます。

TYPESCRIPT

// Claude tool use — 用 OpenAPI 当工具定义
import Anthropic from "@anthropic-ai/sdk";
const client = new Anthropic();

const spec = await (await fetch("https://api.fstar.io/openapi.json")).json();

const msg = await client.messages.create({
  model: "claude-opus-4-8",
  max_tokens: 1024,
  tools: [{
    name: "fstar_get",
    description: "GET any F-Star API path, e.g. /v1/funds/qdfi/nav",
    input_schema: {
      type: "object",
      properties: { path: { type: "string" } },
      required: ["path"],
    },
  }],
  messages: [{ role: "user", content: "What is QDFI's current NAV?" }],
});

読み取り専用クエリを発行する

エージェントに「QDFI の現在の NAV は？」と尋ねると、GET /v1/funds/qdfi/nav を発行し、返ってきた JSON を説明するはずです。

PYTHON

# OpenAI function calling
from openai import OpenAI
import requests, json

client = OpenAI()
tools = [{
  "type": "function",
  "function": {
    "name": "fstar_get",
    "description": "GET an F-Star API path, e.g. /v1/funds/qdfi/nav",
    "parameters": {
      "type": "object",
      "properties": {"path": {"type": "string"}},
      "required": ["path"],
    },
  },
}]

# When the model calls fstar_get(path="/v1/funds/qdfi/nav"):
def fstar_get(path):
    return requests.get("https://api.fstar.io" + path, timeout=10).json()

エラーとレート制限を処理する

すべてのエラーは application/problem+json です。429 のときは Retry-After を読んでバックオフし、If-None-Match を送って ETag による安価な 304 を活用します。

# 错误是 RFC 7807 application/problem+json
curl -s https://api.fstar.io/v1/funds/nope | jq
# {
#   "type": "https://fstar.io/problems/not-found",
#   "title": "Not Found",
#   "status": 404,
#   "detail": "fund \"nope\" not registered; see /v1/funds",
#   "instance": "/v1/funds/nope"
# }

# 限速 429 时读 Retry-After 退避；带 ETag 拿 304 省流量
curl -s -H 'If-None-Match: "abc123"' -D - https://api.fstar.io/v1/funds/qdfi/nav -o /dev/null

MCP

MCP サーバーとしてマウントする

Claude Desktop / Cursor などの MCP クライアントから F-Star API を直接呼び出したいですか？汎用の OpenAPI→MCP ブリッジ（例：openapi-mcp-server）で OpenAPI をラップしてください——グルーコードは不要です。最小限の mcpServers 設定：

JSON

{
  "mcpServers": {
    "fstar": {
      "command": "npx",
      "args": ["-y", "openapi-mcp-server", "https://api.fstar.io/openapi.json"]
    }
  }
}

ブリッジは /openapi.json を読み取り、すべての読み取り専用エンドポイントを MCP ツールとして公開します。ネイティブの F-Star MCP サーバーはロードマップ上（フェーズ3）です。

イベントのプッシュや書き込み操作（ユーザーに代わってサブスクライブする）が必要ですか？それらはロードマップ上です——フェーズ2（SSE + 署名付きレスポンス）とフェーズ4（メタトランザクション・リレイヤー）。v1 は安定した読み取り専用アクセスに注力しています。