@rustledger/mcp-server 0.4.0 → 0.6.0

package/README.md

@@ -48,6 +48,8 @@ Add to your Claude Code settings:
 
 ## Available Tools
 
+### Core Tools
+
 | Tool | Description |
 |------|-------------|
 | `validate` | Validate a Beancount ledger for errors |
@@ -59,6 +61,69 @@ Add to your Claude Code settings:
 | `list_plugins` | List available native plugins |
 | `run_plugin` | Run a native plugin on a ledger |
 
+### Editor Tools (LSP-like)
+
+| Tool | Description |
+|------|-------------|
+| `editor_completions` | Get context-aware completions at a position |
+| `editor_hover` | Get hover information for symbols |
+| `editor_definition` | Go to definition for accounts/currencies |
+| `editor_document_symbols` | Get document outline/structure |
+| `editor_references` | Find all references to accounts/currencies/payees |
+
+### Analysis Tools
+
+| Tool | Description |
+|------|-------------|
+| `ledger_stats` | Get statistics (directive counts, date range, etc.) |
+| `list_accounts` | List all accounts with open/close dates |
+| `list_commodities` | List all currencies/commodities |
+| `account_activity` | Get activity summary for an account |
+
+### Utility Tools
+
+| Tool | Description |
+|------|-------------|
+| `format_check` | Check if ledger is properly formatted |
+| `bql_tables` | Get BQL table documentation |
+| `directive_at_line` | Get directive at a specific line |
+| `find_transactions` | Find transactions by criteria |
+
+### Report Tools
+
+| Tool | Description |
+|------|-------------|
+| `report` | Generate balance sheet, income, holdings, networth |
+
+### File Operation Tools
+
+| Tool | Description |
+|------|-------------|
+| `validate_file` | Validate a file from filesystem |
+| `query_file` | Run BQL query on a file |
+| `format_file` | Format a file (with optional write-back) |
+
+## Resources
+
+The server exposes documentation resources:
+
+| Resource | Description |
+|----------|-------------|
+| `rustledger://docs/bql` | BQL Query Language Reference |
+| `rustledger://docs/validation-errors` | All 27 validation error codes |
+| `rustledger://docs/bql-functions` | Complete BQL function reference |
+| `rustledger://docs/directives` | Beancount directive syntax |
+
+## Prompts
+
+The server provides helpful prompts:
+
+| Prompt | Description |
+|--------|-------------|
+| `analyze_ledger` | Analyze a ledger for insights |
+| `write_query` | Help write BQL queries from natural language |
+| `categorize_transaction` | Help categorize transactions |
+
 ## Example Usage
 
 Once configured, you can ask your AI assistant:
@@ -67,12 +132,38 @@ Once configured, you can ask your AI assistant:
 - "What's my current balance in Assets:Checking?"
 - "Show me all restaurant expenses this month"
 - "Format this beancount ledger"
+- "Generate a balance sheet report"
+- "Find all transactions with 'Amazon' in the payee"
+- "What accounts do I have?"
 
-## Resources
+## Development
+
+To develop the MCP server locally with a local build of the WASM package:
+
+```bash
+# Build the WASM package
+cd crates/rustledger-wasm
+wasm-pack build --target web
+
+# Rename package for npm link compatibility
+cd pkg
+sed -i 's/"name": "rustledger-wasm"/"name": "@rustledger\/wasm"/' package.json
+npm link
+
+# Link in the MCP server
+cd ../../../packages/mcp-server
+npm link @rustledger/wasm
+npm install
+npm run build
+```
 
-The server also exposes documentation:
+To unlink and use the published npm package:
 
-- `rustledger://docs/bql` - BQL Query Language Reference
+```bash
+cd packages/mcp-server
+npm unlink @rustledger/wasm
+npm install
+```
 
 ## License
 

package/dist/__tests__/index.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.test.d.ts.map

package/dist/__tests__/index.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.test.d.ts","sourceRoot":"","sources":["../../src/__tests__/index.test.ts"],"names":[],"mappings":""}