Dòng lệnh và biến môi trường
Mục lục
Trang này viết cho vnstock_mcp v1.0.0rc1, bản thử nghiệm. Tên hàm, tham số và cột dữ liệu có thể còn đổi trước ngày phát hành; khi cài, ghi rõ số phiên bản như ở trang Cài đặt. Bản đang phát hành chính thức là v0.4.0, xem tài liệu bản đó.
Lệnh
Chạy trong terminal. vnstock-mcp không kèm gì mở giao diện tương tác; các lệnh dưới đây gõ được ở cả dòng lệnh lẫn
trong giao diện đó, trừ khi ghi khác.
| Lệnh | Làm gì |
|---|---|
vnstock-mcp onboard [--json] | Quy tắc, trạng thái máy và việc tiếp theo, viết cho trợ lý AI đọc trước khi dùng |
vnstock-mcp status [--json] | Phiên bản, cấp quyền, nguồn có khoá, số tool, ứng dụng đã nối. Chỉ ở dòng lệnh |
vnstock-mcp doctor | Kiểm môi trường, cấu hình, quyền đọc thư mục và một lời gọi dữ liệu thật |
vnstock-mcp setup [ứng dụng] [--write] | Nối vào một ứng dụng AI; không tên thì liệt kê. Giống --setup |
vnstock-mcp sources [show] | Nguồn dùng được và quy tắc nguồn đang áp |
vnstock-mcp sources which <route> | Nguồn nào đọc được một loại dữ liệu, ví dụ market.equity.ohlcv |
vnstock-mcp sources use <nguồn>… [--route mẫu] | Lưu quy tắc: nguồn đầu là chính, sau là dự phòng; --route như market.equity.* |
vnstock-mcp sources clear [--route mẫu] | Bỏ quy tắc |
vnstock-mcp tools [tên] [--profile hồ sơ] | Tool đang hiện; nêu tên để xem tham số |
vnstock-mcp call <tool> [tham_số=giá_trị …] | Gọi thử một tool ngay trên dòng lệnh, ví dụ vnstock-mcp call market_equity symbol=FPT source=ssi |
vnstock-mcp workspace [--json] | Thư mục nghiên cứu: bảng đã lưu, script tái lập |
vnstock-mcp serve [--profile hồ sơ] [-t truyền tải] | Chạy máy chủ MCP. Ứng dụng AI tự gọi lệnh này. Chỉ ở dòng lệnh |
Khoá nguồn thuộc lệnh vnstock (vnstock keys set <nguồn>), tài khoản Vnstock thuộc vnstock login, vnstock status. vnstock-mcp không bọc lại các lệnh này.
Tham số của máy chủ
| Tham số | Mặc định | Nghĩa |
|---|---|---|
-t, --transport | stdio | stdio cho ứng dụng desktop và IDE; streamable-http cho công cụ khác trên cùng máy |
--host | 127.0.0.1 | Chỉ nhận địa chỉ loopback: 127.0.0.1, ::1, localhost |
-p, --port | 8000 | Cổng HTTP |
--path | /mcp | Đường dẫn endpoint HTTP |
--token | Bearer token cho HTTP. Nên đặt bằng VNSTOCK_MCP_TOKEN | |
--rate-limit | 120 | Số yêu cầu HTTP tối đa mỗi phút |
--profile | research | minimal, research, data, full |
--layers | mọi tầng | Ví dụ market,quant |
--doctor, --setup [APP], --write | Như lệnh doctor, setup | |
--log-level | WARNING | Mức log ra stderr |
-v, --version | In phiên bản |
Biến môi trường
| Biến | Mặc định | Nghĩa |
|---|---|---|
VNSTOCK_MCP_PROFILE | research | Hồ sơ tool |
VNSTOCK_MCP_LAYERS | mọi tầng | Tầng được bật, ví dụ reference,market,quant |
VNSTOCK_MCP_WORKSPACE | ~/vnstock_research | Thư mục nghiên cứu |
VNSTOCK_MCP_JOURNAL | 1 | Ghi nhật ký phiên ra đĩa; 0 để tắt |
VNSTOCK_MCP_RESULT_MEMORY | 32 | Số kết quả gần nhất giữ trong bộ nhớ để tham chiếu bằng call_id. Kết quả cũ hơn phải gọi lại hoặc lưu bằng research_save |
VNSTOCK_MCP_MAX_ROWS | 60 | Số dòng mỗi kết quả hiện cho trợ lý |
VNSTOCK_MCP_DIGITS | 6 | Số chữ số có nghĩa hiện cho trợ lý; tệp lưu giữ nguyên |
VNSTOCK_MCP_FORMAT | table | table (cột và dòng, gọn hơn) hoặc records (mỗi dòng một đối tượng) |
VNSTOCK_MCP_TIMEOUT | 60 | Số giây chờ mỗi lần gọi tool; 0 là không giới hạn |
VNSTOCK_MCP_CACHE | 1 | Giữ kết quả theo thời hạn để không gọi lại nguồn khi trợ lý hỏi lặp |
VNSTOCK_MCP_CACHE_SIZE | 256 | Số kết quả tối đa trong cache |
VNSTOCK_MCP_IMPORT_MB | 200 | Dung lượng tệp lớn nhất research_import đọc |
VNSTOCK_MCP_TOKEN | Bearer token cho HTTP | |
VNSTOCK_TELEMETRY | 0 để tắt đo lường lượt dùng trên máy này |
Đo lường lượt dùng
Đo lường tắt cho đến khi tài khoản Vnstock đồng ý trên vnstocks.com. Khi bật, máy chủ chỉ ghi: tool nào được gọi, cặp tool liền kề, nhóm ứng dụng AI, stdio hay HTTP, mã lỗi. Không ghi mã chứng khoán, tham số, câu hỏi hay dữ liệu.