Dropstone Docs

சர்வர்

HTTP மூலம் dropstone சர்வரை இடைவினை செய்யவும்.

dropstone serve கட்டளை ஒரு தலையற்ற HTTP சர்வரை இயக்குகிறது, இது Dropstone கிளையன்ட் பயன்படுத்தக்கூடிய OpenAPI எண்ட்பாயிண்டை வெளிப்படுத்துகிறது.

பயன்பாடு

dropstone serve [--port <number>] [--hostname <string>] [--cors <origin>]

விருப்பங்கள்

கொடிவிளக்கம்இயல்புநிலை
--portகேட்க வேண்டிய போர்ட்4096
--hostnameகேட்க வேண்டிய ஹோஸ்ட்நேம்127.0.0.1
--mdnsmDNS கண்டுபிடிப்பை இயக்கவும்false
--mdns-domainmDNS சேவைக்கான தனிப்பயன் டொமைன் பெயர்dropstone.local
--corsஅனுமதிக்க வேண்டிய கூடுதல் உலாவி மூலங்கள்[]

--cors பல முறை அனுப்பப்படலாம்:

dropstone serve --cors http://localhost:5173 --cors https://app.example.com

அங்கீகாரம்

HTTP அடிப்படை அங்கீகாரத்துடன் சர்வரைப் பாதுகாக்க DROPSTONE_SERVER_PASSWORD ஐ அமைக்கவும். பயனர்பெயர் இயல்பாக dropstone ஆகும், அல்லது அதை மேலெழுத DROPSTONE_SERVER_USERNAME ஐ அமைக்கவும். இது dropstone serve மற்றும் dropstone web இரண்டிற்கும் பொருந்தும்.

DROPSTONE_SERVER_PASSWORD=your-password dropstone serve

இது எவ்வாறு செயல்படுகிறது

dropstone serve OpenAPI 3.1 HTTP எண்ட்பாயிண்ட் மூலம் Dropstone இன் திறன்களை வெளிப்படுத்துகிறது. SDK உருவாக்க அதே எண்ட்பாயிண்ட் பயன்படுத்தப்படுகிறது.

நீங்கள் Dropstone ஐ நிரல்படியாக இயக்க விரும்பினால் சர்வரைப் பயன்படுத்தவும்: ஒரு ஸ்கிரிப்ட்டிலிருந்து, CI பைப்லைனிலிருந்து, அல்லது உங்கள் சொந்த ஒருங்கிணைப்பிலிருந்து. ஊடாடும் அமர்வு மற்றும் சர்வர் சுயாதீனமாக உள்ளன. dropstone serve ஐ இயக்குவது ஒரு ஊடாடும் அமர்வு திறந்திருந்தாலும் இல்லாவிட்டாலும் ஒரு புதிய தனிநபர் சர்வரைத் தொடங்குகிறது.

--hostname மற்றும் --port கொடிகளுடன் பைண்ட் முகவரியை மேலெழுதலாம்.

விவரக்குறிப்பு

சர்வர் OpenAPI 3.1 விவரக்குறிப்பை வெளியிடுகிறது, இதை பார்க்கலாம்:

http://<hostname>:<port>/doc

எடுத்துக்காட்டாக, http://localhost:4096/doc. கிளையன்ட்களை உருவாக்க அல்லது கோரிக்கை மற்றும் பதிலளிப்பு வகைகளை ஆய்வு செய்ய விவரக்குறிப்பைப் பயன்படுத்தவும். அல்லது Swagger ஆய்வாளரில் பார்க்கவும்.

API கள்

dropstone சர்வர் பின்வரும் API களை வெளிப்படுத்துகிறது.

உலகளாவிய

முறைபாதைவிளக்கம்பதிலளிப்பு
GET/global/healthசர்வர் ஆரோக்கியம் மற்றும் பதிப்பு பெறவும்{ healthy: true, version: string }
GET/global/eventஉலகளாவிய நிகழ்வுகளைப் பெறவும் (SSE ஸ்ட்ரீம்)நிகழ்வு ஸ்ட்ரீம்

திட்டம்

முறைபாதைவிளக்கம்பதிலளிப்பு
GET/projectஅனைத்து திட்டங்களையும் பட்டியலிடவும்Project[]
GET/project/currentதற்போதைய திட்டத்தைப் பெறவும்Project

பாதை & VCS

முறைபாதைவிளக்கம்பதிலளிப்பு
GET/pathதற்போதைய பாதையைப் பெறவும்Path
GET/vcsதற்போதைய திட்டத்திற்கான VCS தகவலைப் பெறவும்VcsInfo

கட்டமைப்பு

முறைபாதைவிளக்கம்பதிலளிப்பு
GET/configகட்டமைப்பு தகவலைப் பெறவும்Config
PATCH/configகட்டமைப்பைப் புதுப்பிக்கவும்Config

அமர்வுகள்

முறைபாதைவிளக்கம்குறிப்புகள்
GET/sessionஅனைத்து அமர்வுகளையும் பட்டியலிடவும்Session[] ஐ வழங்குகிறது
POST/sessionஒரு புதிய அமர்வை உருவாக்கவும்body: { parentID?, title? }, Session ஐ வழங்குகிறது
GET/session/statusஅனைத்து அமர்வுகளுக்கான அமர்வு நிலையைப் பெறவும்{ [sessionID: string]: SessionStatus} ஐ வழங்குகிறது
GET/session/:idஅமர்வு விவரங்களைப் பெறவும்Session ஐ வழங்குகிறது
DELETE/session/:idஒரு அமர்வு மற்றும் அதன் அனைத்து தரவையும் நீக்கவும்boolean ஐ வழங்குகிறது
PATCH/session/:idஅமர்வு பண்புகளைப் புதுப்பிக்கவும்body: { title? }, Session ஐ வழங்குகிறது
GET/session/:id/childrenஒரு அமர்வின் குழந்தை அமர்வுகளைப் பெறவும்Session[] ஐ வழங்குகிறது
GET/session/:id/todoஒரு அமர்வுக்கான செய்ய வேண்டிய பட்டியலைப் பெறவும்Todo[] ஐ வழங்குகிறது
POST/session/:id/initபயன்பாட்டை பகுப்பாய்வு செய்து AGENTS.md உருவாக்கவும்body: { messageID, providerID, modelID }, boolean ஐ வழங்குகிறது
POST/session/:id/forkஒரு செய்தியில் ஒரு বিদ்யமான அமர்வை பிரிக்கவும்body: { messageID? }, Session ஐ வழங்குகிறது
POST/session/:id/abortஇயங்கும் அமர்வை நிறுத்தவும்boolean ஐ வழங்குகிறது
GET/session/:id/diffஇந்த அமர்வுக்கான வேறுபாட்டைப் பெறவும்query: messageID?, FileDiff[] ஐ வழங்குகிறது
POST/session/:id/summarizeஅமர்வை சுருக்கவும்body: { providerID, modelID }, boolean ஐ வழங்குகிறது
POST/session/:id/revertஒரு செய்தியை மீட்டமைக்கவும்body: { messageID, partID? }, boolean ஐ வழங்குகிறது
POST/session/:id/unrevertஅனைத்து மீட்டமைக்கப்பட்ட செய்திகளை மீட்டெடுக்கவும்boolean ஐ வழங்குகிறது
POST/session/:id/permissions/:permissionIDஅனுமதி கோரிக்கைக்கு பதிலளிக்கவும்body: { response, remember? }, boolean ஐ வழங்குகிறது

செய்திகள்

முறைபாதைவிளக்கம்குறிப்புகள்
GET/session/:id/messageஒரு அமர்வில் செய்திகளைப் பட்டியலிடவும்query: limit?, { info: Message, parts: Part[]}[] ஐ வழங்குகிறது
POST/session/:id/messageஒரு செய்தியை அனுப்பி பதிலுக்காக காத்திருக்கவும்body: { messageID?, model?, agent?, noReply?, system?, tools?, parts }, { info: Message, parts: Part[]} ஐ வழங்குகிறது
GET/session/:id/message/:messageIDசெய்தி விவரங்களைப் பெறவும்{ info: Message, parts: Part[]} ஐ வழங்குகிறது
POST/session/:id/prompt_asyncஒரு செய்தியை ஒத்திசைவற்ற முறையில் அனுப்பவும் (காத்திருக்க வேண்டாம்)body: /session/:id/message போன்றது, 204 No Content ஐ வழங்குகிறது
POST/session/:id/commandஒரு slash கட்டளையை இயக்கவும்body: { messageID?, agent?, model?, command, arguments }, { info: Message, parts: Part[]} ஐ வழங்குகிறது
POST/session/:id/shellஒரு shell கட்டளையை இயக்கவும்body: { agent, model?, command }, { info: Message, parts: Part[]} ஐ வழங்குகிறது

கட்டளைகள்

முறைபாதைவிளக்கம்பதிலளிப்பு
GET/commandஅனைத்து கட்டளைகளையும் பட்டியலிடவும்Command[]

கோப்புகள்

முறைபாதைவிளக்கம்பதிலளிப்பு
GET/find?pattern=<pat>கோப்புகளில் உரையைத் தேடவும்path, lines, line_number, absolute_offset, submatches உடன் பொருந்தும் பொருட்களின் வரிசை
GET/find/file?query=<q>பெயரால் கோப்புகள் மற்றும் கோப்பகங்களைக் கண்டறியவும்string[] (பாதைகள்)
GET/find/symbol?query=<q>பணிப்பெயர் சின்னங்களைக் கண்டறியவும்Symbol[]
GET/file?path=<path>கோப்புகள் மற்றும் கோப்பகங்களைப் பட்டியலிடவும்FileNode[]
GET/file/content?path=<p>ஒரு கோப்பைப் படிக்கவும்FileContent
GET/file/statusট்র্যாக் செய்யப்பட்ட கோப்புகளுக்கான நிலையைப் பெறவும்File[]

/find/file வினவல் அளவுருக்கள்

  • query (தேவை): தேடல் சரம் (fuzzy match)
  • type (விருப்பம்): "file" அல்லது "directory" க்கு முடிவுகளைக் கட்டுப்படுத்தவும்
  • directory (விருப்பம்): தேடலுக்கான திட்ட மூலத்தை மேலெழுதவும்
  • limit (விருப்பம்): அதிகபட்ச முடிவுகள் (1–200)
  • dirs (விருப்பம்): பழைய கொடி ("false" கோப்புகளை மட்டுமே வழங்குகிறது)

LSP, ஃபார்மேட்டர்கள் & MCP

முறைபாதைவிளக்கம்பதிலளிப்பு
GET/lspLSP சர்வர் நிலையைப் பெறவும்LSPStatus[]
GET/formatterஃபார்மேட்டர் நிலையைப் பெறவும்FormatterStatus[]
GET/mcpMCP சர்வர் நிலையைப் பெறவும்{ [name: string]: MCPStatus }
POST/mcpMCP சர்வரை இயக்கவும் சேர்க்கவும்body: { name, config }, MCP நிலை பொருளை வழங்குகிறது

முகவர்கள்

முறைபாதைவிளக்கம்பதிலளிப்பு
GET/agentஅனைத்து கிடைக்கும் முகவர்களையும் பட்டியலிடவும்Agent[]

பதிவுசெய்தல்

முறைபாதைவிளக்கம்பதிலளிப்பு
POST/logபதிவு உள்ளீட்டை எழுதவும். Body: { service, level, message, extra? }boolean

அங்கீகாரம்

முறைபாதைவிளக்கம்பதிலளிப்பு
PUT/auth/:idகொடுக்கப்பட்ட இலக்கத்திற்கான அங்கீகார நற்சான்றுகளை அமைக்கவும்.boolean

நிகழ்வுகள்

முறைபாதைவிளக்கம்பதிலளிப்பு
GET/eventசர்வர்-அனுப்பப்பட்ட நிகழ்வுகள் ஸ்ட்ரீம். முதல் நிகழ்வு server.connected, பின்னர் பேருந்து நிகழ்வுகள்சர்வர்-அனுப்பப்பட்ட நிகழ்வுகள் ஸ்ட்ரீம்

ஆவணங்கள்

முறைபாதைவிளக்கம்பதிலளிப்பு
GET/docOpenAPI 3.1 விவரக்குறிப்புOpenAPI விவரக்குறிப்புடன் HTML பக்கம்
Ctrl+I