Skip to main content
Glama
LZMW

Aurai Advisor (上级顾问 MCP)

by LZMW

Aurai Advisor (MCP-Berater)

Ein MCP-Dienst, der es lokaler KI ermöglicht, bei komplexen Programmierproblemen bei großen entfernten KI-Modellen nachzufragen.

Das aktuelle Repository entspricht der „langfristig nutzbaren“ Version, die nun über diese entscheidenden Fähigkeiten verfügt:

  • Mehrstufige Beratung und Fortschrittsberichte

  • sync_context Dateisynchronisierung

  • Automatischer Upload von Code-/Konfigurationsdateien als Text

  • Sitzungsisolierung (session_id)

  • Persistenz des Verlaufs, Dateisperren, atomares Schreiben

  • Automatische Zusammenfassung des Verlaufs

  • Kürzung des Kontextfensters


Was ist neu in diesem Update

Dieses Haupt-Update konzentriert sich auf folgende Punkte:

  • Fehler behoben, bei dem der Verlauf nach einem Neustart „wiederauferstand“, obwohl er gelöscht wurde

  • session_id Sitzungsisolierung hinzugefügt, um Kontextvermischungen bei verschiedenen Problemen zu vermeiden

  • Echte Konfigurationsmöglichkeiten für AURAI_TEMPERATURE, AURAI_MAX_ITERATIONS, AURAI_LOG_LEVEL usw. implementiert

  • Sichergestellt, dass project_info und ergänzende Antworten tatsächlich an den übergeordneten Berater gesendet werden

  • Dateisperren für den Verlauf und atomares Schreiben hinzugefügt, um das Risiko von beschädigten Verlaufsdateien bei gleichzeitigen Schreibvorgängen zu verringern

  • Automatische Zusammenfassung des Verlaufs hinzugefügt, damit lange Sitzungen nicht zu umfangreich werden

  • Kürzung des Kontextfensters hinzugefügt, AURAI_CONTEXT_WINDOW ist nun voll wirksam

  • sync_context unterstützt jetzt die automatische Umwandlung von Code-/Konfigurationsdateien in sendbaren Text; manuelles Kopieren in .txt ist nicht mehr erforderlich

  • README, Installationsanleitung und Benutzerhandbuch wurden überarbeitet; Installationsschritte stehen nun weiter oben

Wenn Sie dieses Repository zum ersten Mal verwenden, sind die zwei wichtigsten Punkte:

  1. Lesen Sie zuerst die „Installationsanleitung“ unten

  2. Codedateien können jetzt direkt an sync_context übergeben werden


Related MCP server: session-coord-mcp

Wofür ist es geeignet

Dieser MCP eignet sich für den Einsatz in Claude Code oder anderen MCP-Clients, die stdio unterstützen.

Typische Szenarien:

  • Die lokale KI hat es bereits versucht, aber das Problem wurde nicht gelöst

  • Fehlermeldungen, Code, Dokumentation und Konfiguration müssen gemeinsam an den „Senior-Berater“ übergeben werden

  • Komplexe Fehlerbehebungen sollen in einen mehrstufigen Prozess aus „Frage -> Ausführung -> Bericht -> nächster Schritt“ umgewandelt werden


Funktionsübersicht

  • consult_aurai Das primäre Beratungstool. Reichen Sie Fragen, Code-Snippets, Kontext und bereits versuchte Lösungen ein, um Analysen und Empfehlungen für den nächsten Schritt vom Senior-Berater zu erhalten.

  • sync_context Synchronisiert Code- und Dokumentationskontext. Unterstützt jetzt nicht nur .txt/.md, sondern wandelt automatisch Textdateien wie .py/.js/.ts/.json/.yaml/.toml/.ini in sendbare Textinhalte um.

  • report_progress Meldet die Ausführungsergebnisse an den Senior-Berater zurück, um die nächste Iterationsrunde fortzusetzen.

  • get_status Zeigt den aktuellen Sitzungsstatus, die Anzahl der Verlaufsdatensätze sowie die Pfade zu Modell- und Verlaufsdateien an.


Installationsanleitung

Detailliertere Installationsschritte finden Sie unter:

Hier ist der gängigste Installationsablauf:

1. Umgebung vorbereiten

# 需要 Python 3.10+
python --version

# 进入仓库目录
cd G:\codex\mcp-aurai-server

2. Virtuelle Umgebung erstellen und Abhängigkeiten installieren

python -m venv venv
venv\Scripts\activate
pip install -e ".[all-dev]"

3. MCP in Claude Code registrieren

claude mcp add --scope user --transport stdio aurai-advisor ^
  --env AURAI_API_KEY="your-api-key" ^
  --env AURAI_BASE_URL="https://api.example.com/v1" ^
  --env AURAI_MODEL="gpt-4o" ^
  -- "G:\codex\mcp-aurai-server\venv\Scripts\python.exe" "-m" "mcp_aurai.server"

Hinweise:

  • AURAI_BASE_URL muss eine OpenAI-kompatible Schnittstellenadresse sein

  • Die aktuelle Version behält nur den custom-Modus bei, AURAI_PROVIDER wird nicht mehr verwendet

  • --scope user bedeutet, dass es in allen Projekten verfügbar ist, was am einfachsten ist

4. Installation überprüfen

claude mcp list
pytest

Erwartung:

  • claude mcp list zeigt aurai-advisor an

  • pytest läuft erfolgreich durch


Schnelleinstieg

Szenario 1: Direkt eine Frage stellen

consult_aurai(
    problem_type="runtime_error",
    error_message="启动时报 KeyError: api_key",
    code_snippet="config = load_config()\napi_key = config['api_key']",
    context={
        "file_path": "src/config.py",
        "terminal_output": "Traceback ...",
    }
)

Szenario 2: Erst Codedateien hochladen, dann fragen

sync_context(
    operation="incremental",
    files=["src/main.py", "config/settings.json", "README.md"],
    project_info={
        "project_name": "My Project",
        "tech_stack": "Python + FastAPI"
    }
)

consult_aurai(
    problem_type="runtime_error",
    error_message="请结合已同步文件帮我排查启动失败"
)

Hinweis:

  • main.py muss nicht mehr manuell in main.txt kopiert werden

  • Text-Codedateien werden automatisch in Text umgewandelt und gesendet

  • Binärdateien werden übersprungen

Szenario 3: Mehrere Probleme parallel, Sitzungsisolierung nutzen

consult_aurai(
    problem_type="runtime_error",
    error_message="问题 A",
    session_id="issue-a"
)

consult_aurai(
    problem_type="design_issue",
    error_message="问题 B",
    session_id="issue-b"
)

Dies verhindert, dass sich verschiedene Probleme gegenseitig stören.


sync_context Dateiupload-Regeln

Wird direkt gesendet

  • .md, .markdown, .mdx

  • .txt

  • Verschiedene Code- und Konfigurationstextdateien, zum Beispiel:

    • .py .js .ts .tsx

    • .json .yaml .yml .toml

    • .ini .cfg .env

    • .java .go .rs .cpp .cs

Wird automatisch konvertiert

  • Dateien, die keine .txt/.md sind, deren Inhalt aber Text ist

  • Es wird automatisch ein .txt oder .md Dateiname für den Versand generiert

  • Vor dem Inhalt werden der „ursprüngliche Dateipfad“ und der „automatisch konvertierte Dateiname“ angefügt

Wird übersprungen

  • Bilder

  • Archivdateien

  • Audio/Video

  • Ausführbare Dateien

  • Offensichtliche Binärinhalte

Wenn eine Dateigruppe sowohl Code als auch Bilder enthält:

  • Code wird wie gewohnt hochgeladen

  • Bilder werden als skipped_files markiert

  • Die Synchronisierung als Ganzes ist weiterhin erfolgreich


Umgebungsvariablen

Erforderlich

Variable

Beschreibung

AURAI_API_KEY

API-Schlüssel

AURAI_BASE_URL

OpenAI-kompatible Schnittstellenadresse

AURAI_MODEL

Modellname

Häufig verwendete Optionen

Variable

Beschreibung

Standardwert

AURAI_TEMPERATURE

Temperatur

0.7

AURAI_MAX_ITERATIONS

Maximale Iterationsrunden

10

AURAI_MAX_HISTORY

Obergrenze der gespeicherten Verlaufsdatensätze pro Sitzung

50

AURAI_CONTEXT_WINDOW

Gesamtgröße des Kontextfensters

200000

AURAI_MAX_MESSAGE_TOKENS

Obergrenze für einzelne große Dateinachrichten

150000

AURAI_MAX_TOKENS

Maximale Ausgabelänge

32000

AURAI_LOG_LEVEL

Protokollebene

INFO

AURAI_ENABLE_PERSISTENCE

Verlauf persistieren

true

AURAI_HISTORY_PATH

Standardpfad für Sitzungsverlaufsdatei

~/.mcp-aurai/history.json

AURAI_HISTORY_LOCK_TIMEOUT

Wartezeit für Dateisperre (Sekunden)

10

AURAI_ENABLE_HISTORY_SUMMARY

Zusammenfassung des Verlaufs aktivieren

true

AURAI_HISTORY_SUMMARY_KEEP_RECENT

Anzahl der nach Zusammenfassung beibehaltenen ursprünglichen Runden

3

AURAI_HISTORY_SUMMARY_TRIGGER

Schwellenwert für die Auslösung der Zusammenfassung

8


Wichtige Verhaltensweisen der aktuellen Version

1. Sitzungsisolierung

  • Jede session_id hat ihren eigenen Verlauf

  • Wenn nichts übergeben wird, wird default verwendet

  • Verschiedene Sitzungen werden in unterschiedlichen Verlaufsdateien gespeichert, um Vermischungen zu vermeiden

2. Zusammenfassung des Verlaufs

  • Älterer Verlauf wird automatisch in eine „Verlaufszusammenfassung“ komprimiert

  • Die letzten Runden und der letzte sync_context werden nach Möglichkeit im Original beibehalten

  • Dies reduziert die Kontextbelegung und schafft Platz für das aktuelle Problem

3. Kürzung des Kontextfensters

  • System-Prompts werden bevorzugt beibehalten

  • Der letzte sync_context wird bevorzugt beibehalten

  • Die letzten Verlaufsrunden werden nach Möglichkeit beibehalten

  • Bei Bedarf wird die aktuelle Ausgabelänge automatisch reduziert, um das Gesamtfenster nicht zu überschreiten

4. Stabilere Verlaufsdateien

  • Beim Speichern des Verlaufs wird eine Sperrdatei verwendet, um gleichzeitige Schreibfehler zu vermeiden

  • Das Schreiben erfolgt über eine temporäre Datei, die dann ersetzt wird, um unvollständige JSON-Dateien zu vermeiden


Testen

pytest

Die aktuellen Schwerpunkte umfassen:

  • Löschen und Persistenz des Verlaufs

  • Sitzungsisolierung

  • Automatischer Textkonvertierungs-Upload

  • Verlaufs-Sperren und atomares Schreiben

  • Verlaufszusammenfassung

  • Kürzung des Kontextfensters


Dokumentation


Häufig gestellte Fragen

Warum hat der Senior-Berater meine hochgeladenen Codedateien nicht erhalten?

Ältere Versionen erforderten eine manuelle Konvertierung in .txt. Die aktuelle Version unterstützt die automatische Konvertierung von Textdateien.

Falls sie immer noch nicht ankommen, prüfen Sie zuerst:

  • Existiert der Dateipfad?

  • Ist die Datei binär?

  • Was steht in uploaded_files / skipped_files der sync_context-Antwort?

Warum beeinflussen sich verschiedene Probleme gegenseitig?

Wenn Sie eine vollständige Isolierung wünschen, übergeben Sie für verschiedene Probleme unterschiedliche session_ids.

Warum sieht die Verlaufsdatei kürzer aus?

Das ist die Verlaufszusammenfassung bei der Arbeit. Der alte Verlauf wurde in ein Protokoll komprimiert; er ist nicht verloren, sondern wurde durch ein kontextschonenderes „Sitzungsprotokoll“ ersetzt.

Available Tools

4 tools
consult_auraiA

请求上级AI的指导(支持交互对齐机制与多轮对话)

这是核心工具,当本地AI遇到编程问题时调用此工具获取上级AI的指导建议。


🔗 相关工具

  • sync_context:需要上传文档或代码时使用

    • 📄 上传文章、说明文档(.md/.txt)

    • 💻 上传代码文件(避免内容被截断) ⭐ 重要

    • 将 .py/.js/.json 等代码文件复制为 .txt 后上传

  • report_progress:执行上级 AI 建议后,使用此工具报告进度并获取下一步指导

  • get_status:查看当前对话状态、迭代次数、配置信息

💡 重要提示:避免内容被截断

如果 code_snippet 或 context 内容过长,请使用 sync_context 上传文件:

# 步骤 1:将代码文件复制为 .txt
shutil.copy('script.py', 'script.txt')

# 步骤 2:上传文件
sync_context(operation='incremental', files=['script.txt'])

# 步骤 3:告诉上级顾问文件已上传
consult_aurai(
    error_message='请审查已上传的 script.txt 文件'
)

优势:

  • ✅ 避免代码在 context 或 answers_to_questions 字段中被截断

  • ✅ 利用文件读取机制,完整传递内容

  • ✅ 支持任意大小的代码文件


[重要] 何时开始新对话?

系统会自动检测,但你也可以手动控制:

  • 自动清空:当上一次对话返回 resolved=true 时,系统会自动清空历史

  • 手动清空:如果你要讨论一个完全不同的新问题,设置 is_new_question=true

何时设置 is_new_question=true?

  • [OK] 切换到完全不相关的项目/文件

  • [OK] 之前的问题已解决,现在遇到全新的问题

  • [OK] 发现上下文混乱,想重新开始

  • 不要在同一个问题的多轮对话中使用

交互协议

1. 多轮对齐机制

  • 不要期待一次成功:上级顾问可能会认为信息不足,返回反问问题

  • 仔细阅读 questions_to_answer 中的每个问题

  • 主动搜集信息(读取文件、检查日志、运行命令)

  • 再次调用 此工具,将答案填入 answers_to_questions 参数

2. 首次调用

必须提供:

  • problem_type:问题类型(runtime_error/syntax_error/design_issue/other)

  • error_message:清晰描述问题或错误

  • context:相关上下文(代码片段、环境信息、已尝试的方案)

  • code_snippet:相关代码(如果有)

3. 后续调用(当返回 status="need_info" 时)

必须提供:

  • answers_to_questions:对上级顾问反问的详细回答

  • 保持其他参数不变(除非有新信息)

4. 诚实原则

  • 禁止瞎编:如果不知道答案,诚实说明"未找到相关信息"

  • 禁止臆测:不要在没有证据的情况下假设解决方案

  • 提供具体证据(文件路径、日志内容、错误堆栈)

响应格式

信息不足时 (status="need_info")

{
  "status": "need_info",
  "questions_to_answer": ["问题1", "问题2"],
  "instruction": "请搜集信息并再次调用"
}

提供指导时 (status="success")

{
  "status": "success",
  "analysis": "问题分析",
  "guidance": "解决建议",
  "action_items": ["步骤1", "步骤2"],
  "resolved": false  // 是否已完全解决
}

问题解决后

当 resolved=true 时,对话历史会自动清空,下次查询将开始新对话。

[自动] 新对话检测

系统会自动检测新问题:

  • 如果上一次对话的 resolved=true,下次调用 consult_aurai 时会自动清空历史

  • 保证每个独立问题都有干净的上下文,避免干扰

[重要] 明确标注新问题(可选参数)

如果你想强制开始一个新对话,可以设置 is_new_question=true:

  • 效果:立即清空所有之前的对话历史

  • 后果:上级AI将无法看到之前的任何上下文

  • 使用场景:

    • 之前的对话已完全无关

    • 想重新开始讨论一个全新的问题

    • 发现上下文混乱,想重置

示例:

# 第一次咨询(问题A)
consult_aurai(problem_type="runtime_error", error_message="...")

# 继续讨论问题A...
consult_aurai(answers_to_questions="...")

# 切换到问题B(标注为新问题,清空历史)
consult_aurai(
    problem_type="design_issue",
    error_message="...",
    is_new_question=True  # [注意] 会清空之前关于问题A的所有对话
)
ParametersJSON Schema
NameRequiredDescriptionDefault
problem_typeYes问题类型: runtime_error, syntax_error, design_issue, other
error_messageYes错误描述
code_snippetNo相关代码片段
contextNo上下文信息(支持 JSON 字符串或字典,会自动解析)
attempts_madeNo已尝试的解决方案
answers_to_questionsNo对上级顾问反问的回答(仅在多轮对话时使用)
is_new_questionNo[重要] 是否为新问题(新问题会清空之前的所有对话历史,确保干净的上下文)

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

A4.7/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of behavioral disclosure and excels. It describes the multi-round interaction protocol (status='need_info' triggers follow-up calls), honest principle requirements (no fabrication), automatic history clearing when resolved=true, consequences of is_new_question (clears all prior context), and response formats. It adds rich context beyond what the input schema provides.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is comprehensive but overly long and not front-loaded. While it contains valuable information, it includes extensive formatting (markdown, code blocks, emojis) and repetitive sections (e.g., multiple warnings about truncation, redundant explanations of is_new_question). Some content could be condensed without losing clarity, making it less efficient than ideal.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (multi-round interaction, 7 parameters), no annotations, and the presence of an output schema, the description is exceptionally complete. It covers purpose, usage, behavioral protocols, parameter guidance, sibling tool relationships, and response handling. The output schema existence means return values needn't be explained, and the description fully compensates for the lack of annotations with detailed operational context.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema description coverage is 100%, so the baseline is 3. The description adds significant value by explaining parameter usage in context: it specifies which parameters are required for first calls (problem_type, error_message, context, code_snippet) vs. follow-up calls (answers_to_questions), provides examples for code_snippet/context handling with sync_context, and clarifies the impact of is_new_question. However, it doesn't add deep semantic nuance beyond the schema's descriptions for all parameters.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description explicitly states the tool's purpose: '请求上级AI的指导' (request guidance from a higher-level AI) and '当本地AI遇到编程问题时调用此工具获取上级AI的指导建议' (call this tool when the local AI encounters programming problems to get guidance from a higher-level AI). It clearly distinguishes from siblings by explaining this is the '核心工具' (core tool) for obtaining AI guidance, while sibling tools handle context synchronization, progress reporting, and status checking.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides extensive usage guidelines, including when to use this tool ('当本地AI遇到编程问题时'), when to use sibling tools instead (e.g., use sync_context for uploading files to avoid truncation, report_progress after executing suggestions), and explicit alternatives. It also details when to set parameters like is_new_question and provides scenarios for manual vs. automatic context clearing.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

get_statusB

获取当前状态

返回当前对话状态、迭代次数、配置信息等。


返回内容:conversation_history_count(对话历史数量)、max_iterations(最大迭代次数)、max_history(最大历史条数)、provider(AI提供商)、model(模型名称)

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

B3.4/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden of behavioral disclosure. It describes what the tool returns (conversation state, iteration count, configuration) and lists specific return fields, which adds useful context about the tool's behavior. However, it doesn't mention whether this is a read-only operation, if it requires authentication, or any rate limits—important details for a status-checking tool with zero annotation coverage.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is appropriately sized and front-loaded: the first line states the purpose clearly, followed by details on return content. The use of a separator (---) and bullet points for return fields improves readability. However, the inclusion of both Chinese and English text slightly reduces efficiency, and some redundancy exists (e.g., stating return content in two ways).

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's simplicity (0 parameters, no annotations, but has an output schema), the description is reasonably complete. It explains what the tool does and details the return values, which compensates for the lack of annotations. Since an output schema exists, the description doesn't need to fully explain return values, but it still provides a helpful overview. For a status-retrieval tool, this is adequate though not exhaustive.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The tool has 0 parameters with 100% schema description coverage (empty schema), so the baseline is 4 as per the rules for zero parameters. The description appropriately doesn't discuss parameters since none exist, and it focuses on the return values instead, which is correct given the context.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose: '获取当前状态' (get current status) and specifies it returns conversation state, iteration count, and configuration information. This is a specific verb+resource combination that distinguishes it from sibling tools like consult_aurai, report_progress, and sync_context, which appear to perform different functions. However, it doesn't explicitly contrast with siblings beyond implying different functionality.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention any prerequisites, appropriate contexts, or comparisons with sibling tools like consult_aurai or report_progress. The agent must infer usage from the purpose alone, which is insufficient for optimal tool selection.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

report_progressA

报告执行进度,请求下一步指导

在执行了上级AI的建议后,调用此工具报告结果,获取下一步指导。


使用场景:执行上级 AI 建议后,报告执行结果并获取后续指导 参数:actions_taken(已执行的行动)、result(success/failed/partial)、new_error(新错误)、feedback(反馈)

ParametersJSON Schema
NameRequiredDescriptionDefault
actions_takenYes已执行的行动
resultYes执行结果: success, failed, partial
new_errorNo新的错误信息
feedbackNo执行反馈

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

A4.4/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of behavioral disclosure. It effectively describes the tool's purpose and workflow (reporting progress and requesting guidance), though it doesn't specify technical details like response format, rate limits, or authentication requirements. However, it clearly communicates the tool's interactive nature and expected usage pattern.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured and appropriately sized. It opens with a clear purpose statement, provides usage guidelines, and includes a formatted section with usage scenarios and parameters. Every sentence serves a purpose with no redundancy or wasted words.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's moderate complexity (4 parameters, interactive workflow) and the presence of an output schema (which handles return values), the description is largely complete. It covers purpose, usage context, and parameters adequately. The main gap is lack of behavioral details like error handling or response structure, but the output schema mitigates this.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema already documents all parameters thoroughly. The description lists parameters in a section but doesn't add meaningful semantic context beyond what's in the schema (e.g., explaining how 'result' influences guidance or what constitutes good 'feedback'). This meets the baseline for high schema coverage.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose with specific verbs ('报告执行进度' - report execution progress, '请求下一步指导' - request next-step guidance) and distinguishes it from siblings like consult_aurai (consultation), get_status (status retrieval), and sync_context (context synchronization). It explicitly defines the tool's role in reporting results after executing superior AI suggestions.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit usage guidelines: '在执行了上级AI的建议后,调用此工具报告结果,获取下一步指导' (After executing superior AI suggestions, call this tool to report results and get next-step guidance). It clearly defines when to use this tool (post-execution reporting) versus alternatives like consult_aurai (for consultation before execution) or get_status (for status checking without guidance).

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

sync_contextA

同步代码上下文(支持上传 .md 和 .txt 文件,避免内容被截断)

在第一次调用或上下文发生重大变化时使用,让上级AI了解当前项目的整体情况。


🎯 典型使用场景

场景 1:上传文章供上级顾问评审

sync_context(
    operation='full_sync',
    files=['文章.md'],
    project_info={
        'task': 'article_review',
        'target_platform': 'GLM Coding 知识库'
    }
)
consult_aurai(
    problem_type='other',
    error_message='请评审以下投稿文章...',
    context={'请查看已上传的文章文件': '已通过 sync_context 上传'}
)

场景 2:上传代码文件(避免内容被截断)⭐ 重要

# 问题:代码太长,在 context 字段中可能被截断
# 解决:将代码转换为 .txt 文件后上传

import shutil

# 步骤 1:将代码文件复制为 .txt
shutil.copy('src/main.py', 'src/main.txt')

# 步骤 2:上传文件
sync_context(
    operation='incremental',
    files=['src/main.txt'],
    project_info={
        'description': '需要调试的代码',
        'language': 'Python'
    }
)

# 步骤 3:告诉上级顾问文件已上传
consult_aurai(
    problem_type='runtime_error',
    error_message='请审查已上传的 src/main.txt 文件,帮我找出bug',
    context={
        'file_location': '已通过 sync_context 上传',
        'expected_behavior': '应该输出...',
        'actual_behavior': '实际输出...'
    }
)

优势:

  • ✅ 避免代码在 context 或 answers_to_questions 字段中被截断

  • ✅ 利用 sync_context 的文件读取机制,完整传递内容

  • ✅ 上级顾问可以完整读取代码文件

场景 3:项目首次初始化

sync_context(
    operation='full_sync',
    files=['README.md', 'docs/说明文档.md'],
    project_info={
        'project_name': 'My Project',
        'tech_stack': 'Python + FastAPI'
    }
)

[注意] 文件上传限制

files 参数只支持 .txt 和 .md 文件!

  • [OK] 支持:README.md, docs.txt, notes.md 等文本和Markdown文件

  • 不支持:.py, .js, .json, .yaml 等代码文件

使用场景

  1. full_sync: 完整同步,适合首次调用或项目重大变更

  2. incremental: 增量同步,适合添加新文件或更新

  3. clear: 清空对话历史

Token优化

当 project_info 中的单个字段超过 800 tokens 时,会自动:

  • 缓存到临时文件

  • 在对话历史中记录文件路径

  • 发送给上级AI时仍会读取完整内容

参数说明

  • operation: 操作类型(full_sync/incremental/clear)

  • files: 文件路径列表,只能是 .txt 或 .md 文件

  • project_info: 项目信息字典,可包含任意字段

ParametersJSON Schema
NameRequiredDescriptionDefault
operationYes操作类型: full_sync(完整同步), incremental(增量添加), clear(清空历史)
filesNo**⚠️ 只支持 .txt 和 .md 文件!** 如需上传代码文件(.py/.js/.json等),必须先复制为 .txt。示例: shutil.copy('script.py', 'script.txt') 然后传 files=['script.txt']。文件路径列表(支持 JSON 字符串或列表,会自动解析)
project_infoNo项目信息字典,可包含项目名称、技术栈、任务描述等任意字段(支持 JSON 字符串或字典,会自动解析)

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

A4.5/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of behavioral disclosure. It effectively describes key behaviors: file type restrictions (.txt and .md only), token optimization (caching for fields >800 tokens), and the three operation modes (full_sync, incremental, clear) with their purposes. However, it doesn't mention potential side effects like whether files are stored persistently, if there are rate limits, or authentication requirements, leaving some gaps for a mutation tool.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured with sections for typical scenarios, notes, and parameter explanations, but it is overly verbose. The extensive code examples and scenario details could be condensed; not every sentence earns its place as some repetition occurs (e.g., file restrictions mentioned multiple times). It's front-loaded with the core purpose, but the length may reduce scanability.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (mutation with file handling) and rich schema (100% coverage, output schema exists), the description is highly complete. It covers purpose, usage guidelines, behavioral traits, parameter semantics with examples, and operational details. The output schema handles return values, so the description appropriately focuses on input and behavior, leaving no significant gaps for agent understanding.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema already documents all parameters. The description adds significant value beyond the schema by explaining the rationale behind file restrictions (to avoid truncation), providing concrete usage examples with code snippets, and detailing token optimization behavior. However, it doesn't fully explain the semantics of 'project_info' beyond stating it can contain arbitrary fields, missing guidance on typical or required fields.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose: '同步代码上下文(支持上传 .md 和 .txt 文件,避免内容被截断)' - to sync code context by uploading .md and .txt files to avoid truncation. It specifies the verb (sync/upload), resource (code context via files), and distinguishes from siblings by focusing on file-based context management rather than consultation, status checking, or progress reporting.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit guidance on when to use this tool: '在第一次调用或上下文发生重大变化时使用' (use on first call or when context changes significantly). It includes detailed scenarios (article review, code upload, project initialization) with concrete examples and contrasts with alternatives by noting that code should be uploaded here instead of placed in 'context' or 'answers_to_questions' fields of other tools to avoid truncation.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

  1. 4 tool updatesv2.2.0
    • First observedconsult_aurai
    • First observedget_status
    • First observedreport_progress
    • First observedsync_context

TDQS

A4.2/5.0

Scored across 4 tools

Disambiguation5/5

Each tool has a distinct, non-overlapping purpose: consult_aurai for core advice, sync_context for file uploads, report_progress for progress updates, and get_status for status checks. The descriptions clearly differentiate their roles, with no ambiguity in when to use each tool.

Naming Consistency5/5

All tool names follow a consistent snake_case pattern with clear verb_noun structures: consult_aurai, sync_context, report_progress, get_status. This uniformity makes the set predictable and easy to understand for an agent.

Tool Count5/5

With 4 tools, this server is well-scoped for its purpose of providing AI-guided problem-solving. Each tool serves a specific function in the workflow (consult, sync, report, status), and there are no extraneous or missing tools for the domain.

Completeness5/5

The tool set fully covers the intended workflow: initiating consultations (consult_aurai), providing context (sync_context), reporting progress (report_progress), and checking status (get_status). There are no gaps; agents can handle the entire lifecycle from problem submission to resolution.

Maintenance

ActivityInactive
ResponsivenessNo issues

Related MCP Connectors

Related MCP Servers