Skip to content

Commit 3263f8e

Browse files
committed
Clean up post-release docs
1 parent f2422c9 commit 3263f8e

5 files changed

Lines changed: 20 additions & 8 deletions

File tree

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
*.user
66
*.userosscache
77
*.sln.docstates
8+
.DS_Store
89
# User-specific files (MonoDevelop/Xamarin Studio)
910
*.userprefs
1011
# Build results
@@ -202,4 +203,3 @@ ModelManifest.xml
202203
/Harmony/Documentation/api/*.html
203204
/Harmony/Documentation/api/*.yml
204205
/Harmony/Documentation/Documentation.dll
205-
.DS_Store

ARCHITECTURE.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ Documentation policy:
1515
Key startup behavior:
1616
- registers `DecompilerWorkspace` plus the legacy singleton services;
1717
- registers `WorkspaceBootstrapService`;
18-
- calls `.AddMcpServer().WithStdioServerTransport().WithToolsFromAssembly()`;
18+
- configures concise MCP server instructions through `McpServerOptions.ServerInstructions`;
19+
- calls `.AddMcpServer(...).WithStdioServerTransport().WithToolsFromAssembly()`;
1920
- initializes `ServiceLocator` with the built service provider.
2021

2122
Tool shape:
@@ -198,6 +199,17 @@ Unknown-assembly exploration should stay inside MCP tools:
198199
- use `list_members` or `get_members_of_type` after a type is found;
199200
- if a member-based tool receives a stale or human-entered symbol, return structured candidates and suggested next tool calls rather than only `Invalid member ID`.
200201

202+
### MCP Server Instructions
203+
204+
`Program.ServerInstructions` is intentionally short and workflow-oriented.
205+
206+
It should:
207+
- steer clients toward `search_symbols`, `list_members`, structured errors, and common parameter names;
208+
- complement the tool schemas rather than duplicate the full README or tool reference;
209+
- stay concise enough to be useful in the MCP handshake.
210+
211+
If the workflow changes, update `Program.ServerInstructions`, the Codex skill, and this section together.
212+
201213
## Compare Model
202214

203215
Comparison is intentionally layered so the caller can stay cheap on context and only drill in when needed.

TODO.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ Goal:
3333
- Let callers trade detail for cost when the default response is too verbose.
3434

3535
Candidate work:
36-
- Add a shared `mode` parameter with values such as `minimal`, `summary`, and `detailed`.
37-
- Start with `get_member_details`, `search_types`, `search_members`, and `get_decompiled_source`.
36+
- Extend the existing member-summary modes (`ids`, `discovery`, `signatures`, `full`) beyond search/list endpoints where they fit.
37+
- Consider smaller output modes for `get_member_details` and `get_decompiled_source`.
3838
- Keep the default behavior stable so existing callers do not silently lose information.
3939

4040
### Error reporting and diagnostics
@@ -43,8 +43,8 @@ Goal:
4343
- Make failures easier to act on without forcing the caller to guess what went wrong.
4444

4545
Candidate work:
46-
- Add stable error codes for common failure cases.
47-
- Include suggestions for fuzzy misses where there is a clear likely match, using the symbol-exploration diagnostics above as the model.
46+
- Extend stable error codes beyond the current symbol-resolution and assembly-loaded cases.
47+
- Include suggestions for more fuzzy misses where there is a clear likely match, using the symbol-exploration diagnostics as the model.
4848
- Add a `validate_assembly` or equivalent health-check tool.
4949
- Expand `get_server_stats` with diagnostic warnings where useful.
5050

Tests/AnalysisToolTests.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,7 @@ public void FindDerivedTypes_TransitiveParameter_AffectsResults()
236236
}
237237

238238
[Fact]
239-
public void GetIL_WithValidMethod_ReturnsILSummary()
239+
public void GetIL_WithValidMethod_ReturnsILInstructions()
240240
{
241241
// Arrange - find a method from the test assembly
242242
var testType = ContextManager.FindTypeByName("TestLibrary.SimpleClass");

Tools/GetIL.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ public static string GetIL(string memberId, string format = "IL", string? contex
2525
// Only support IL format for now, ILAst would require additional implementation
2626
if (format != "IL")
2727
{
28-
throw new NotSupportedException($"Format '{format}' is not supported. Only 'IL' format is currently supported, and it currently returns metadata summary output rather than full body disassembly.");
28+
throw new NotSupportedException($"Format '{format}' is not supported. Only 'IL' format is currently supported.");
2929
}
3030

3131
var method = ToolValidation.ResolveMethodOrThrow(session, memberId);

0 commit comments

Comments
 (0)